Class ZlibDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.compression.ZlibDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

Direct Known Subclasses:

JdkZlibDecoder, JZlibDecoder

public abstract class ZlibDecoder
extends ByteToMessageDecoder

Decompresses a ByteBuf using the deflate algorithm.

Nested Class Summary

Nested classes/interfaces inherited from class ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ZlibDecoder()	Same as ZlibDecoder(int) with maxAllocation = 0.
ZlibDecoder(int maxAllocation)	Construct a new ZlibDecoder.

Method Summary

Modifier and Type	Method	Description
protected void	decompressionBufferExhausted(ByteBuf buffer)	Called when the decompression buffer cannot be expanded further.
abstract boolean	isClosed()	Returns true if and only if the end of the compressed stream has been reached.
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, channelReadComplete, decode, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class Object

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

Methods inherited from interface ChannelHandler

handlerAdded

Field Details

maxAllocation

protected final int maxAllocation

Maximum allowed size of the decompression buffer.

Constructor Details

ZlibDecoder

public ZlibDecoder()

Same as ZlibDecoder(int) with maxAllocation = 0.

ZlibDecoder

public ZlibDecoder(int maxAllocation)

Construct a new ZlibDecoder.

Parameters:

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

Method Details

isClosed

public abstract boolean isClosed()

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

prepareDecompressBuffer

protected ByteBuf prepareDecompressBuffer(ChannelHandlerContext ctx,
 ByteBuf buffer,
 int preferredSize)

Allocate or expand the decompression buffer, without exceeding the maximum allocation. Calls decompressionBufferExhausted(ByteBuf) if the buffer is full and cannot be expanded further.

decompressionBufferExhausted

protected void decompressionBufferExhausted(ByteBuf buffer)

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.