Class JdkZlibDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.compression.ZlibDecoder

io.netty.handler.codec.compression.JdkZlibDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class JdkZlibDecoder
extends ZlibDecoder

Decompress a ByteBuf using the inflate algorithm.

Nested Class Summary

Nested classes/interfaces inherited from class ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Modifier and Type	Class	Description
static interface	ByteToMessageDecoder.Cumulator	Cumulate ByteBufs.

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Field Summary

Fields inherited from class ZlibDecoder

maxAllocation

Modifier and Type	Field	Description
protected final int	maxAllocation	Maximum allowed size of the decompression buffer.

Fields inherited from class ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Modifier and Type	Field	Description
static final ByteToMessageDecoder.Cumulator	COMPOSITE_CUMULATOR	Cumulate ByteBufs by add them to a CompositeByteBuf and so do no memory copy whenever possible.
static final ByteToMessageDecoder.Cumulator	MERGE_CUMULATOR	Cumulate ByteBufs by merge them into one ByteBuf's, using memory copies.

Constructor Summary

Constructors

Constructor	Description
JdkZlibDecoder()	Deprecated. Use JdkZlibDecoder(int).
JdkZlibDecoder(boolean decompressConcatenated)	Deprecated. Use JdkZlibDecoder(boolean, int).
JdkZlibDecoder(boolean decompressConcatenated, int maxAllocation)
JdkZlibDecoder(byte[] dictionary)	Deprecated. Use JdkZlibDecoder(byte[], int).
JdkZlibDecoder(byte[] dictionary, int maxAllocation)	Creates a new instance with the specified preset dictionary and maximum buffer allocation.
JdkZlibDecoder(int maxAllocation)	Creates a new instance with the default wrapper (ZlibWrapper.ZLIB) and the specified maximum buffer allocation.
JdkZlibDecoder(ZlibWrapper wrapper)	Deprecated. Use JdkZlibDecoder(ZlibWrapper, int).
JdkZlibDecoder(ZlibWrapper wrapper, boolean decompressConcatenated)	Deprecated. Use JdkZlibDecoder(ZlibWrapper, boolean, int).
JdkZlibDecoder(ZlibWrapper wrapper, boolean decompressConcatenated, int maxAllocation)
JdkZlibDecoder(ZlibWrapper wrapper, int maxAllocation)	Creates a new instance with the specified wrapper and maximum buffer allocation.

Method Summary

Modifier and Type	Method	Description
void	channelReadComplete(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Decode the from one ByteBuf to an other.
protected void	decompressionBufferExhausted(ByteBuf buffer)	Called when the decompression buffer cannot be expanded further.
protected void	handlerRemoved0(ChannelHandlerContext ctx)	Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.
boolean	isClosed()	Returns true if and only if the end of the compressed stream has been reached.

Methods inherited from class ZlibDecoder

prepareDecompressBuffer

Modifier and Type	Method	Description
protected ByteBuf	prepareDecompressBuffer(ChannelHandlerContext ctx, ByteBuf buffer, int preferredSize)	Allocate or expand the decompression buffer, without exceeding the maximum allocation.

Methods inherited from class ByteToMessageDecoder

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

Modifier and Type	Method	Description
protected int	actualReadableBytes()	Returns the actual number of readable bytes in the internal cumulative buffer of this decoder.
protected void	callDecode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Called once data should be decoded from the given ByteBuf.
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRead(ChannelHandlerContext ctx, Object input)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	decodeLast(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Is called one last time when the ChannelHandlerContext goes in-active.
protected final void	discardSomeReadBytes()
final void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
protected ByteBuf	internalBuffer()	Returns the internal cumulative buffer of this decoder.
boolean	isSingleDecode()	If true then only one message is decoded on each ByteToMessageDecoder.channelRead(ChannelHandlerContext, Object) call.
void	setCumulator(ByteToMessageDecoder.Cumulator cumulator)	Set the ByteToMessageDecoder.Cumulator to use for cumulate the received ByteBufs.
void	setDiscardAfterReads(int discardAfterReads)	Set the number of reads after which ByteBuf.discardSomeReadBytes() are called and so free up memory.
void	setSingleDecode(boolean singleDecode)	If set then only one message is decoded on each ByteToMessageDecoder.channelRead(ChannelHandlerContext, Object) call.
void	userEventTriggered(ChannelHandlerContext ctx, Object evt)	Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Modifier and Type	Method	Description
void	channelActive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JdkZlibDecoder

@Deprecated
public JdkZlibDecoder()

Deprecated.

Use JdkZlibDecoder(int).

Creates a new instance with the default wrapper (ZlibWrapper.ZLIB).

JdkZlibDecoder

public JdkZlibDecoder(int maxAllocation)

Creates a new instance with the default wrapper (ZlibWrapper.ZLIB) and the specified maximum buffer allocation.

Parameters:

maxAllocation - Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the ByteBufAllocator.

JdkZlibDecoder

@Deprecated
public JdkZlibDecoder(byte[] dictionary)

Deprecated.

Use JdkZlibDecoder(byte[], int).

Creates a new instance with the specified preset dictionary. The wrapper is always ZlibWrapper.ZLIB because it is the only format that supports the preset dictionary.

JdkZlibDecoder

public JdkZlibDecoder(byte[] dictionary,
 int maxAllocation)

Creates a new instance with the specified preset dictionary and maximum buffer allocation. The wrapper is always ZlibWrapper.ZLIB because it is the only format that supports the preset dictionary.

Parameters:

maxAllocation - Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the ByteBufAllocator.

JdkZlibDecoder

@Deprecated
public JdkZlibDecoder(ZlibWrapper wrapper)

Deprecated.

Use JdkZlibDecoder(ZlibWrapper, int).

Creates a new instance with the specified wrapper. Be aware that only ZlibWrapper.GZIP, ZlibWrapper.ZLIB and ZlibWrapper.NONE are supported atm.

JdkZlibDecoder

public JdkZlibDecoder(ZlibWrapper wrapper,
 int maxAllocation)

Creates a new instance with the specified wrapper and maximum buffer allocation. Be aware that only ZlibWrapper.GZIP, ZlibWrapper.ZLIB and ZlibWrapper.NONE are supported atm.

Parameters:

maxAllocation - Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the ByteBufAllocator.

JdkZlibDecoder

@Deprecated
public JdkZlibDecoder(ZlibWrapper wrapper,
 boolean decompressConcatenated)

Deprecated.

Use JdkZlibDecoder(ZlibWrapper, boolean, int).

JdkZlibDecoder

public JdkZlibDecoder(ZlibWrapper wrapper,
 boolean decompressConcatenated,
 int maxAllocation)

JdkZlibDecoder

@Deprecated
public JdkZlibDecoder(boolean decompressConcatenated)

Deprecated.

Use JdkZlibDecoder(boolean, int).

JdkZlibDecoder

public JdkZlibDecoder(boolean decompressConcatenated,
 int maxAllocation)

Method Details

isClosed

public boolean isClosed()

Description copied from class: ZlibDecoder

Returns true if and only if the end of the compressed stream has been reached.

Specified by:

isClosed in class ZlibDecoder

decode

protected void decode(ChannelHandlerContext ctx,
 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

decompressionBufferExhausted

protected void decompressionBufferExhausted(ByteBuf buffer)

Description copied from class: ZlibDecoder

Called when the decompression buffer cannot be expanded further. Default implementation is a no-op, but subclasses can override in case they want to do something before the DecompressionException is thrown, such as log the data that was decompressed so far.

Overrides:

decompressionBufferExhausted in class ZlibDecoder

handlerRemoved0

protected void handlerRemoved0(ChannelHandlerContext ctx)
                        throws Exception

Description copied from class: ByteToMessageDecoder

Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.

Overrides:

handlerRemoved0 in class ByteToMessageDecoder

Throws:

Exception

channelReadComplete

public void channelReadComplete(ChannelHandlerContext ctx)
                         throws Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelReadComplete in interface ChannelInboundHandler

Overrides:

channelReadComplete in class ByteToMessageDecoder

Throws:

Exception