io.netty.handler.codec

Class FixedLengthFrameDecoder

java.lang.Object

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder<Object>

io.netty.handler.codec.FixedLengthFrameDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundByteHandler, ChannelInboundHandler, ChannelStateHandler

public class FixedLengthFrameDecoder
extends ByteToMessageDecoder<Object>

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 interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
FixedLengthFrameDecoder(int frameLength) Calls FixedLengthFrameDecoder(int, boolean) with false
FixedLengthFrameDecoder(int frameLength, boolean allocateFullBuffer) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
Object	decode(ChannelHandlerContext ctx, ByteBuf in)
ByteBuf	newInboundBuffer(ChannelHandlerContext ctx)

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

beforeAdd, callDecode, channelInactive, decodeLast, inboundBufferUpdated, replace

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

afterAdd, afterRemove, beforeRemove, channelActive, channelRegistered, channelUnregistered, 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.ChannelStateHandler

channelActive, channelRegistered, channelUnregistered

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

FixedLengthFrameDecoder

public FixedLengthFrameDecoder(int frameLength)

Calls FixedLengthFrameDecoder(int, boolean) with false

FixedLengthFrameDecoder

public FixedLengthFrameDecoder(int frameLength,
                       boolean allocateFullBuffer)

Creates a new instance.

Parameters:

frameLength - the length of the frame

allocateFullBuffer - true if the cumulative ByteBuf should use the frameLength as its initial size

Method Detail

newInboundBuffer

public ByteBuf newInboundBuffer(ChannelHandlerContext ctx)
                         throws Exception

Specified by:

newInboundBuffer in interface ChannelInboundByteHandler

Specified by:

newInboundBuffer in interface ChannelInboundHandler

Overrides:

newInboundBuffer in class ByteToMessageDecoder<Object>

Throws:

Exception

decode

public Object decode(ChannelHandlerContext ctx,
            ByteBuf in)
              throws Exception

Specified by:

decode in class ByteToMessageDecoder<Object>

Throws:

Exception