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 aByteBuf
using the inflate 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
-
Fields inherited from class io.netty.handler.codec.compression.ZlibDecoder
maxAllocation
-
Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR
-
-
Constructor Summary
Constructors Constructor Description JdkZlibDecoder()
Creates a new instance with the default wrapper (ZlibWrapper.ZLIB
).JdkZlibDecoder(boolean decompressConcatenated)
JdkZlibDecoder(boolean decompressConcatenated, int maxAllocation)
JdkZlibDecoder(byte[] dictionary)
Creates a new instance with the specified preset dictionary.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)
Creates a new instance with the specified wrapper.JdkZlibDecoder(ZlibWrapper wrapper, boolean decompressConcatenated)
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)
Decode the from oneByteBuf
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 theByteToMessageDecoder
was removed from the actual context and it doesn't handle events anymore.boolean
isClosed()
Returnstrue
if and only if the end of the compressed stream has been reached.-
Methods inherited from class io.netty.handler.codec.compression.ZlibDecoder
prepareDecompressBuffer
-
Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, 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
-
-
-
-
Constructor Detail
-
JdkZlibDecoder
public JdkZlibDecoder()
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 theByteBufAllocator
.
-
JdkZlibDecoder
public JdkZlibDecoder(byte[] dictionary)
Creates a new instance with the specified preset dictionary. The wrapper is alwaysZlibWrapper.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 alwaysZlibWrapper.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 theByteBufAllocator
.
-
JdkZlibDecoder
public JdkZlibDecoder(ZlibWrapper wrapper)
Creates a new instance with the specified wrapper. Be aware that onlyZlibWrapper.GZIP
,ZlibWrapper.ZLIB
andZlibWrapper.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 onlyZlibWrapper.GZIP
,ZlibWrapper.ZLIB
andZlibWrapper.NONE
are supported atm.- Parameters:
maxAllocation
- Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by theByteBufAllocator
.
-
JdkZlibDecoder
public JdkZlibDecoder(ZlibWrapper wrapper, boolean decompressConcatenated)
-
JdkZlibDecoder
public JdkZlibDecoder(ZlibWrapper wrapper, boolean decompressConcatenated, int maxAllocation)
-
JdkZlibDecoder
public JdkZlibDecoder(boolean decompressConcatenated)
-
JdkZlibDecoder
public JdkZlibDecoder(boolean decompressConcatenated, int maxAllocation)
-
-
Method Detail
-
isClosed
public boolean isClosed()
Description copied from class:ZlibDecoder
Returnstrue
if and only if the end of the compressed stream has been reached.- Specified by:
isClosed
in classZlibDecoder
-
decode
protected void decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out) throws java.lang.Exception
Description copied from class:ByteToMessageDecoder
Decode the from oneByteBuf
to an other. This method will be called till either the inputByteBuf
has nothing to read when return from this method or till nothing was read from the inputByteBuf
.- Specified by:
decode
in classByteToMessageDecoder
- Parameters:
ctx
- theChannelHandlerContext
which thisByteToMessageDecoder
belongs toin
- theByteBuf
from which to read dataout
- theList
to which decoded messages should be added- Throws:
java.lang.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 theDecompressionException
is thrown, such as log the data that was decompressed so far.- Overrides:
decompressionBufferExhausted
in classZlibDecoder
-
handlerRemoved0
protected void handlerRemoved0(ChannelHandlerContext ctx) throws java.lang.Exception
Description copied from class:ByteToMessageDecoder
Gets called after theByteToMessageDecoder
was removed from the actual context and it doesn't handle events anymore.- Overrides:
handlerRemoved0
in classByteToMessageDecoder
- Throws:
java.lang.Exception
-
-