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
Decompresses a
ByteBuf
using the deflate algorithm.-
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
FieldsModifier and TypeFieldDescriptionprotected final int
Maximum allowed size of the decompression buffer.Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR
-
Constructor Summary
ConstructorsConstructorDescriptionSame asZlibDecoder(int)
with maxAllocation = 0.ZlibDecoder
(int maxAllocation) Construct a new ZlibDecoder. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
decompressionBufferExhausted
(ByteBuf buffer) Called when the decompression buffer cannot be expanded further.abstract boolean
isClosed()
Returnstrue
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 io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decode, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered
Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught
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 Details
-
maxAllocation
protected final int maxAllocationMaximum allowed size of the decompression buffer.
-
-
Constructor Details
-
ZlibDecoder
public ZlibDecoder()Same asZlibDecoder(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 theByteBufAllocator
.
-
-
Method Details
-
isClosed
public abstract boolean isClosed()Returnstrue
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. CallsdecompressionBufferExhausted(ByteBuf)
if the buffer is full and cannot be expanded further. -
decompressionBufferExhausted
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 theDecompressionException
is thrown, such as log the data that was decompressed so far.
-