io.netty.handler.codec

Class ByteToMessageDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler

Direct Known Subclasses:

DelimiterBasedFrameDecoder, FixedLengthFrameDecoder, LengthFieldBasedFrameDecoder, LineBasedFrameDecoder, ProtobufVarint32FrameDecoder, ReplayingDecoder, SnappyFramedDecoder, XmlFrameDecoder, ZlibDecoder

public abstract class ByteToMessageDecoder
extends io.netty.channel.ChannelHandlerAdapter

A ChannelHandler which decodes bytes in a stream-like fashion from one ByteBuf to an other Message type. For example here is an implementation which reads all readable bytes from the input ByteBuf and create a new ByteBuf.

     public class SquareDecoder extends ByteToMessageDecoder {
         @Override
         public void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)
                 throws Exception {
             out.add(in.readBytes(in.readableBytes()));
         }
     }
 

Be aware that sub-classes of ByteToMessageDecoder MUST NOT annotated with @Sharable.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable, io.netty.channel.ChannelHandler.Skip

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ByteToMessageDecoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	actualReadableBytes() Returns the actual number of readable bytes in the internal cumulative buffer of this decoder.
protected void	callDecode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, List<Object> out) Called once data should be decoded from the given ByteBuf.
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg)
void	channelReadComplete(io.netty.channel.ChannelHandlerContext ctx)
protected abstract void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, List<Object> out) Decode the from one ByteBuf to an other.
protected void	decodeLast(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, List<Object> out) Is called one last time when the ChannelHandlerContext goes in-active.
void	handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)
protected void	handlerRemoved0(io.netty.channel.ChannelHandlerContext ctx) Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.
protected io.netty.buffer.ByteBuf	internalBuffer() Returns the internal cumulative buffer of this decoder.
boolean	isSingleDecode() If true then only one message is decoded on each channelRead(ChannelHandlerContext, Object) call.
void	setSingleDecode(boolean singleDecode) If set then only one message is decoded on each channelRead(ChannelHandlerContext, Object) call.

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, channelActive, channelRegistered, channelWritabilityChanged, close, connect, disconnect, exceptionCaught, flush, handlerAdded, isSharable, read, userEventTriggered, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteToMessageDecoder

protected ByteToMessageDecoder()

Method Detail

setSingleDecode

public void setSingleDecode(boolean singleDecode)

If set then only one message is decoded on each channelRead(ChannelHandlerContext, Object) call. This may be useful if you need to do some protocol upgrade and want to make sure nothing is mixed up. Default is false as this has performance impacts.

isSingleDecode

public boolean isSingleDecode()

If true then only one message is decoded on each channelRead(ChannelHandlerContext, Object) call. Default is false as this has performance impacts.

actualReadableBytes

protected int actualReadableBytes()

Returns the actual number of readable bytes in the internal cumulative buffer of this decoder. You usually do not need to rely on this value to write a decoder. Use it only when you must use it at your own risk. This method is a shortcut to internalBuffer().readableBytes().

internalBuffer

protected io.netty.buffer.ByteBuf internalBuffer()

Returns the internal cumulative buffer of this decoder. You usually do not need to access the internal buffer directly to write a decoder. Use it only when you must use it at your own risk.

handlerRemoved

public final void handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)
                          throws Exception

Specified by:

handlerRemoved in interface io.netty.channel.ChannelHandler

Overrides:

handlerRemoved in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

handlerRemoved0

protected void handlerRemoved0(io.netty.channel.ChannelHandlerContext ctx)
                        throws Exception

Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.

Throws:

Exception

channelRead

public void channelRead(io.netty.channel.ChannelHandlerContext ctx,
               Object msg)
                 throws Exception

Specified by:

channelRead in interface io.netty.channel.ChannelHandler

Overrides:

channelRead in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

channelReadComplete

public void channelReadComplete(io.netty.channel.ChannelHandlerContext ctx)
                         throws Exception

Specified by:

channelReadComplete in interface io.netty.channel.ChannelHandler

Overrides:

channelReadComplete in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

channelInactive

public void channelInactive(io.netty.channel.ChannelHandlerContext ctx)
                     throws Exception

Specified by:

channelInactive in interface io.netty.channel.ChannelHandler

Overrides:

channelInactive in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

callDecode

protected void callDecode(io.netty.channel.ChannelHandlerContext ctx,
              io.netty.buffer.ByteBuf in,
              List<Object> out)

Called once data should be decoded from the given ByteBuf. This method will call decode(ChannelHandlerContext, ByteBuf, List) as long as decoding should take place.

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

decode

protected abstract void decode(io.netty.channel.ChannelHandlerContext ctx,
          io.netty.buffer.ByteBuf in,
          List<Object> out)
                        throws Exception

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read anymore, till nothing was read from the input ByteBuf or till this method returns null.

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error accour

decodeLast

protected void decodeLast(io.netty.channel.ChannelHandlerContext ctx,
              io.netty.buffer.ByteBuf in,
              List<Object> out)
                   throws Exception

Is called one last time when the ChannelHandlerContext goes in-active. Which means the channelInactive(ChannelHandlerContext) was triggered. By default this will just call decode(ChannelHandlerContext, ByteBuf, List) but sub-classes may override this for some special cleanup operation.

Throws:

Exception