io.netty.handler.codec.marshalling

Class CompatibleMarshallingDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

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

io.netty.handler.codec.marshalling.CompatibleMarshallingDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class CompatibleMarshallingDecoder
extends ReplayingDecoder<java.lang.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 class io.netty.handler.codec.ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

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

ChannelHandler.Sharable

Field Summary

Fields

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

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

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	decode(ChannelHandlerContext ctx, ByteBuf buffer, java.util.List<java.lang.Object> out) Decode the from one ByteBuf to an other.
protected void	decodeLast(ChannelHandlerContext ctx, ByteBuf buffer, java.util.List<java.lang.Object> out) Is called one last time when the ChannelHandlerContext goes in-active.
void	exceptionCaught(ChannelHandlerContext ctx, java.lang.Throwable cause) Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.

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

callDecode, checkpoint, checkpoint, state, state

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

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

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged

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

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 void decode(ChannelHandlerContext ctx,
                      ByteBuf buffer,
                      java.util.List<java.lang.Object> out)
               throws java.lang.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

buffer - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

java.lang.Exception - is thrown if an error occurs

decodeLast

protected void decodeLast(ChannelHandlerContext ctx,
                          ByteBuf buffer,
                          java.util.List<java.lang.Object> out)
                   throws java.lang.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, List) but sub-classes may override this for some special cleanup operation.

Overrides:

decodeLast in class ByteToMessageDecoder

Throws:

java.lang.Exception

exceptionCaught

public void exceptionCaught(ChannelHandlerContext ctx,
                            java.lang.Throwable cause)
                     throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

exceptionCaught in interface ChannelHandler

Specified by:

exceptionCaught in interface ChannelInboundHandler

Overrides:

exceptionCaught in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception