io.netty.handler.codec.base64

Class Base64Encoder

java.lang.Object

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

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

io.netty.handler.codec.base64.Base64Encoder

All Implemented Interfaces:

ChannelHandler, ChannelOperationHandler, ChannelOutboundHandler, ChannelOutboundMessageHandler<ByteBuf>

@ChannelHandler.Sharable
public class Base64Encoder
extends MessageToMessageEncoder<ByteBuf,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

ChannelHandler.Sharable

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ByteBuf	encode(ChannelHandlerContext ctx, ByteBuf msg)
boolean	isEncodable(Object msg) Returns true if and only if the specified message can be encoded by this encoder.

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

flush

Methods inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

newOutboundBuffer

Methods inherited from class io.netty.channel.ChannelOperationHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, bind, close, connect, deregister, disconnect, 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

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

isEncodable

public boolean isEncodable(Object msg)
                    throws Exception

Description copied from class: MessageToMessageEncoder

Returns true if and only if the specified message can be encoded by this encoder.

Overrides:

isEncodable in class MessageToMessageEncoder<ByteBuf,ByteBuf>

Parameters:

msg - the message

Throws:

Exception

encode

public ByteBuf encode(ChannelHandlerContext ctx,
             ByteBuf msg)
               throws Exception

Specified by:

encode in class MessageToMessageEncoder<ByteBuf,ByteBuf>

Throws:

Exception