Class JZlibDecoder
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.JZlibDecoder
- All Implemented Interfaces:
ChannelHandler
,ChannelInboundHandler
-
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 TypeFieldDescriptionprivate byte[]
private boolean
private final com.jcraft.jzlib.Inflater
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
ConstructorsConstructorDescriptionCreates a new instance with the default wrapper (ZlibWrapper.ZLIB
).JZlibDecoder
(byte[] dictionary) Creates a new instance with the specified preset dictionary.JZlibDecoder
(byte[] dictionary, int maxAllocation) Creates a new instance with the specified preset dictionary and maximum buffer allocation.JZlibDecoder
(int maxAllocation) Creates a new instance with the default wrapper (ZlibWrapper.ZLIB
) and specified maximum buffer allocation.JZlibDecoder
(ZlibWrapper wrapper) Creates a new instance with the specified wrapper.JZlibDecoder
(ZlibWrapper wrapper, int maxAllocation) Creates a new instance with the specified wrapper and maximum buffer allocation. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
decode
(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) Decode the from oneByteBuf
to an other.protected void
decompressionBufferExhausted
(ByteBuf buffer) Called when the decompression buffer cannot be expanded further.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, 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
-
z
private final com.jcraft.jzlib.Inflater z -
dictionary
private byte[] dictionary -
finished
private volatile boolean finished
-
-
Constructor Details
-
JZlibDecoder
public JZlibDecoder()Creates a new instance with the default wrapper (ZlibWrapper.ZLIB
).- Throws:
DecompressionException
- if failed to initialize zlib
-
JZlibDecoder
public JZlibDecoder(int maxAllocation) Creates a new instance with the default wrapper (ZlibWrapper.ZLIB
) and specified maximum buffer allocation.- Parameters:
maxAllocation
- Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by theByteBufAllocator
.- Throws:
DecompressionException
- if failed to initialize zlib
-
JZlibDecoder
Creates a new instance with the specified wrapper.- Throws:
DecompressionException
- if failed to initialize zlib
-
JZlibDecoder
Creates a new instance with the specified wrapper and maximum buffer allocation.- Parameters:
maxAllocation
- Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by theByteBufAllocator
.- Throws:
DecompressionException
- if failed to initialize zlib
-
JZlibDecoder
public JZlibDecoder(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.- Throws:
DecompressionException
- if failed to initialize zlib
-
JZlibDecoder
public JZlibDecoder(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
.- Throws:
DecompressionException
- if failed to initialize zlib
-
-
Method Details
-
isClosed
public boolean isClosed()Returnstrue
if and only if the end of the compressed stream has been reached.- Specified by:
isClosed
in classZlibDecoder
-
decode
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:
Exception
- is thrown if an error occurs
-
decompressionBufferExhausted
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
-