Package io.netty.handler.codec

Class FixedLengthFrameDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.FixedLengthFrameDecoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

public class FixedLengthFrameDecoder
extends ByteToMessageDecoder

A decoder that splits the received ByteBufs by the fixed number of bytes. For example, if you received the following four fragmented packets:

 +---+----+------+----+
 | A | BC | DEFG | HI |
 +---+----+------+----+
 

A FixedLengthFrameDecoder(3) will decode them into the following three packets with the fixed length:

 +-----+-----+-----+
 | ABC | DEF | GHI |
 +-----+-----+-----+
 

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor	Description
FixedLengthFrameDecoder(int frameLength)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected Object	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in)	Create a frame out of the ByteBuf and return it.
protected void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, List<Object> out)	Decode the from one ByteBuf to an other.

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

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

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

handlerAdded

Constructor Detail

FixedLengthFrameDecoder

public FixedLengthFrameDecoder(int frameLength)

Creates a new instance.

Parameters:

frameLength - the length of the frame

Method Detail

decode

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

Description copied from class: ByteToMessageDecoder

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read when return from this method or till nothing was read from the input ByteBuf.

Specified by:

decode in class ByteToMessageDecoder

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 occurs

decode

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

Create a frame out of the ByteBuf and return it.

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

Returns:

frame the ByteBuf which represent the frame or null if no frame could be created.

Throws:

Exception