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 ByteToMessageDecoder
ByteToMessageDecoder.CumulatorNested classes/interfaces inherited from interface ChannelHandler
ChannelHandler.Sharable -
Field Summary
Fields inherited from class ZlibDecoder
maxAllocationFields inherited from class ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.JZlibDecoder(byte[] dictionary) Deprecated.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) Deprecated.JZlibDecoder(ZlibWrapper wrapper, int maxAllocation) Creates a new instance with the specified wrapper and maximum buffer allocation. -
Method Summary
Modifier and TypeMethodDescriptionvoidCallsChannelHandlerContext.fireChannelReadComplete()to forward to the nextChannelInboundHandlerin theChannelPipeline.protected voiddecode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) Decode the from oneByteBufto an other.protected voiddecompressionBufferExhausted(ByteBuf buffer) Called when the decompression buffer cannot be expanded further.booleanisClosed()Returnstrueif and only if the end of the compressed stream has been reached.Methods inherited from class ZlibDecoder
prepareDecompressBufferMethods inherited from class ByteToMessageDecoder
actualReadableBytes, callDecode, channelInactive, channelRead, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggeredMethods inherited from class ChannelInboundHandlerAdapter
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaughtMethods inherited from class ChannelHandlerAdapter
ensureNotSharable, handlerAdded, isSharableMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface ChannelHandler
handlerAdded
-
Constructor Details
-
JZlibDecoder
Deprecated.UseJZlibDecoder(int).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
Deprecated.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
Deprecated.Creates a new instance with the specified preset dictionary. The wrapper is alwaysZlibWrapper.ZLIBbecause 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.ZLIBbecause 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()Returnstrueif and only if the end of the compressed stream has been reached.- Specified by:
isClosedin classZlibDecoder
-
decode
Description copied from class:ByteToMessageDecoderDecode the from oneByteBufto an other. This method will be called till either the inputByteBufhas nothing to read when return from this method or till nothing was read from the inputByteBuf.- Specified by:
decodein classByteToMessageDecoder- Parameters:
ctx- theChannelHandlerContextwhich thisByteToMessageDecoderbelongs toin- theByteBuffrom which to read dataout- theListto which decoded messages should be added- Throws:
Exception- is thrown if an error occurs
-
channelReadComplete
Description copied from class:ChannelInboundHandlerAdapterCallsChannelHandlerContext.fireChannelReadComplete()to forward to the nextChannelInboundHandlerin theChannelPipeline. Sub-classes may override this method to change behavior.- Specified by:
channelReadCompletein interfaceChannelInboundHandler- Overrides:
channelReadCompletein classByteToMessageDecoder- Throws:
Exception
-
decompressionBufferExhausted
Description copied from class:ZlibDecoderCalled 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 theDecompressionExceptionis thrown, such as log the data that was decompressed so far.- Overrides:
decompressionBufferExhaustedin classZlibDecoder
-
JZlibDecoder(int).