io.netty.handler.codec.marshalling

Class CompatibleMarshallingDecoder

java.lang.Object

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

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

io.netty.handler.codec.marshalling.CompatibleMarshallingDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundByteHandler, ChannelInboundHandler, ChannelStateHandler

public class CompatibleMarshallingDecoder
extends ReplayingDecoder<Object,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

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
Object	decode(ChannelHandlerContext ctx, ByteBuf buffer)
Object	decodeLast(ChannelHandlerContext ctx, ByteBuf buffer)
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)

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

actualReadableBytes, callDecode, channelInactive, checkpoint, checkpoint, internalBuffer, newInboundBuffer, state, state

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

beforeAdd, inboundBufferUpdated, replace

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

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

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

Specified by:

decode in class ByteToMessageDecoder<Object>

Throws:

Exception

decodeLast

public Object decodeLast(ChannelHandlerContext ctx,
                ByteBuf buffer)
                  throws Exception

Overrides:

decodeLast in class ByteToMessageDecoder<Object>

Throws:

Exception

exceptionCaught

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

Specified by:

exceptionCaught in interface ChannelHandler

Overrides:

exceptionCaught in class ChannelStateHandlerAdapter

Throws:

Exception