io.netty.handler.codec.base64

Class Base64Decoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundMessageHandlerAdapter<I>

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

io.netty.handler.codec.base64.Base64Decoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelHandlerUtil.SingleInboundMessageHandler<io.netty.buffer.ByteBuf>, io.netty.channel.ChannelInboundMessageHandler<io.netty.buffer.ByteBuf>, io.netty.channel.ChannelStateHandler

@ChannelHandler.Sharable
public class Base64Decoder
extends MessageToMessageDecoder<io.netty.buffer.ByteBuf>

Decodes a Base64-encoded ByteBuf or US-ASCII String into a ByteBuf. Please note that this decoder must be used with a proper ByteToMessageDecoder such as DelimiterBasedFrameDecoder if you are using a stream-based transport such as TCP/IP. A typical decoder 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.ChannelInboundMessageHandlerAdapter

ABORT

Constructor Summary

Constructors

Constructor and Description
Base64Decoder()
Base64Decoder(Base64Dialect dialect)

Method Summary

Methods

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

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

messageReceived

Methods inherited from class io.netty.channel.ChannelInboundMessageHandlerAdapter

acceptInboundMessage, beginMessageReceived, endMessageReceived, freeInboundBuffer, inboundBufferUpdated, newInboundBuffer

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught

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.ChannelStateHandler

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught

Constructor Detail

Base64Decoder

public Base64Decoder()

Base64Decoder

public Base64Decoder(Base64Dialect dialect)

Method Detail

decode

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

Description copied from class: MessageToMessageDecoder

Decode 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:

decode in class MessageToMessageDecoder<io.netty.buffer.ByteBuf>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg - the message to decode to an other one

Returns:

message the decoded 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