io.netty.handler.codec.base64

Class Base64Encoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

io.netty.handler.codec.MessageToMessageEncoder<io.netty.buffer.ByteBuf>

io.netty.handler.codec.base64.Base64Encoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundMessageHandler<io.netty.buffer.ByteBuf>

@ChannelHandler.Sharable
public class Base64Encoder
extends MessageToMessageEncoder<io.netty.buffer.ByteBuf>

Encodes a ByteBuf into a Base64-encoded ByteBuf. A typical setup for TCP/IP would be:

 ChannelPipeline pipeline = ...;

 // Decoders
 pipeline.addLast("frameDecoder", new DelimiterBasedFrameDecoder(80, Delimiters.nulDelimiter()));
 pipeline.addLast("base64Decoder", new Base64Decoder());

 // Encoder
 pipeline.addLast("base64Encoder", new Base64Encoder());
 

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

ABORT

Constructor Summary

Constructors

Constructor and Description
Base64Encoder()
Base64Encoder(boolean breakLines)
Base64Encoder(boolean breakLines, Base64Dialect dialect)

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	encode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf msg) Encode from one message to an other.

Methods inherited from class io.netty.handler.codec.MessageToMessageEncoder

flush

Methods inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

acceptOutboundMessage, beginFlush, endFlush, flush, freeOutboundBuffer, isCloseOnFailedFlush, newOutboundBuffer, setCloseOnFailedFlush

Methods inherited from class io.netty.channel.ChannelOperationHandlerAdapter

bind, close, connect, deregister, disconnect, read, sendFile

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelOperationHandler

bind, close, connect, deregister, disconnect, read, sendFile

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

Base64Encoder

public Base64Encoder()

Base64Encoder

public Base64Encoder(boolean breakLines)

Base64Encoder

public Base64Encoder(boolean breakLines,
             Base64Dialect dialect)

Method Detail

encode

protected Object encode(io.netty.channel.ChannelHandlerContext ctx,
            io.netty.buffer.ByteBuf msg)
                 throws Exception

Description copied from class: MessageToMessageEncoder

Encode from one message to an other. This method will be called till either the MessageBuf has nothing left or till this method returns null.

Specified by:

encode in class MessageToMessageEncoder<io.netty.buffer.ByteBuf>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to

msg - the message to encode to an other one

Returns:

message the encoded message or null if more messages are needed be cause the implementation needs to do some kind of aggragation

Throws:

Exception - is thrown if an error accour