io.netty.handler.codec.marshalling

Class CompatibleMarshallingDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundByteHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.ReplayingDecoder<Void>

io.netty.handler.codec.marshalling.CompatibleMarshallingDecoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundByteHandler, io.netty.channel.ChannelStateHandler

public class CompatibleMarshallingDecoder
extends ReplayingDecoder<Void>

ReplayingDecoder which use an Unmarshaller to read the Object out of the ByteBuf. If you can you should use MarshallingDecoder.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxObjectSize
protected UnmarshallerProvider	provider

Constructor Summary

Constructors

Constructor and Description
CompatibleMarshallingDecoder(UnmarshallerProvider provider, int maxObjectSize) Create a new instance of CompatibleMarshallingDecoder.

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf buffer) Decode the from one ByteBuf to an other.
protected Object	decodeLast(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf buffer) Is called one last time when the ChannelHandlerContext goes in-active.
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)

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

actualReadableBytes, callDecode, channelInactive, channelReadSuspended, checkpoint, checkpoint, discardInboundReadBytes, discardInboundReadBytes0, internalBuffer, newInboundBuffer, newInboundBuffer0, state, state

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

inboundBufferUpdated, isSingleDecode, setSingleDecode

Methods inherited from class io.netty.channel.ChannelInboundByteHandlerAdapter

freeInboundBuffer, inboundBufferUpdated

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelRegistered, channelUnregistered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, 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, beforeAdd, beforeRemove, userEventTriggered

Field Detail

provider

protected final UnmarshallerProvider provider

maxObjectSize

protected final int maxObjectSize

Constructor Detail

CompatibleMarshallingDecoder

public CompatibleMarshallingDecoder(UnmarshallerProvider provider,
                            int maxObjectSize)

Create a new instance of CompatibleMarshallingDecoder.

Parameters:

provider - the UnmarshallerProvider which is used to obtain the Unmarshaller for the Channel

maxObjectSize - the maximal size (in bytes) of the Object to unmarshal. Once the size is exceeded the Channel will get closed. Use a a maxObjectSize of Integer.MAX_VALUE to disable this. You should only do this if you are sure that the received Objects will never be big and the sending side are trusted, as this opens the possibility for a DOS-Attack due an OutOfMemoryError.

Method Detail

decode

protected Object decode(io.netty.channel.ChannelHandlerContext ctx,
            io.netty.buffer.ByteBuf buffer)
                 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 anymore, till nothing was read from the input ByteBuf or till this method returns null.

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToByteDecoder belongs to

buffer - the ByteBuf from which to read data

Returns:

message the message to which the content of the ByteBuf was decoded, or null if there was not enough data left in the ByteBuf to decode.

Throws:

Exception - is thrown if an error accour

decodeLast

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

Description copied from class: ByteToMessageDecoder

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

Overrides:

decodeLast in class ByteToMessageDecoder

Throws:

Exception

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                   Throwable cause)
                     throws Exception

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception