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 aByteBufusing the inflate algorithm.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static classJdkZlibDecoder.GzipState-
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 Modifier and Type Field Description private ByteBufChecksumcrcprivate booleandecideZlibOrNoneprivate booleandecompressConcatenatedprivate byte[]dictionaryprivate static intFCOMMENTprivate static intFEXTRAprivate static intFHCRCprivate booleanfinishedprivate intflagsprivate static intFNAMEprivate static intFRESERVEDprivate JdkZlibDecoder.GzipStategzipStateprivate java.util.zip.Inflaterinflaterprivate intxlen-
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 Modifier 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)privateJdkZlibDecoder(ZlibWrapper wrapper, byte[] dictionary, 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 Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voiddecode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)Decode the from oneByteBufto an other.protected voiddecompressionBufferExhausted(ByteBuf buffer)Called when the decompression buffer cannot be expanded further.protected voidhandlerRemoved0(ChannelHandlerContext ctx)Gets called after theByteToMessageDecoderwas removed from the actual context and it doesn't handle events anymore.booleanisClosed()Returnstrueif and only if the end of the compressed stream has been reached.private static booleanlooksLikeZlib(short cmf_flg)private booleanreadGZIPFooter(ByteBuf buf)private booleanreadGZIPHeader(ByteBuf in)private voidverifyCrc(ByteBuf in)-
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
-
-
-
-
Field Detail
-
FHCRC
private static final int FHCRC
- See Also:
- Constant Field Values
-
FEXTRA
private static final int FEXTRA
- See Also:
- Constant Field Values
-
FNAME
private static final int FNAME
- See Also:
- Constant Field Values
-
FCOMMENT
private static final int FCOMMENT
- See Also:
- Constant Field Values
-
FRESERVED
private static final int FRESERVED
- See Also:
- Constant Field Values
-
inflater
private java.util.zip.Inflater inflater
-
dictionary
private final byte[] dictionary
-
crc
private final ByteBufChecksum crc
-
decompressConcatenated
private final boolean decompressConcatenated
-
gzipState
private JdkZlibDecoder.GzipState gzipState
-
flags
private int flags
-
xlen
private int xlen
-
finished
private volatile boolean finished
-
decideZlibOrNone
private boolean decideZlibOrNone
-
-
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.ZLIBbecause 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.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.
-
JdkZlibDecoder
public JdkZlibDecoder(ZlibWrapper wrapper)
Creates a new instance with the specified wrapper. Be aware that onlyZlibWrapper.GZIP,ZlibWrapper.ZLIBandZlibWrapper.NONEare 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.ZLIBandZlibWrapper.NONEare 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)
-
JdkZlibDecoder
private JdkZlibDecoder(ZlibWrapper wrapper, byte[] dictionary, boolean decompressConcatenated, int maxAllocation)
-
-
Method Detail
-
isClosed
public boolean isClosed()
Description copied from class:ZlibDecoderReturnstrueif and only if the end of the compressed stream has been reached.- Specified by:
isClosedin classZlibDecoder
-
decode
protected void decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out) throws java.lang.Exception
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:
java.lang.Exception- is thrown if an error occurs
-
decompressionBufferExhausted
protected void decompressionBufferExhausted(ByteBuf buffer)
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
-
handlerRemoved0
protected void handlerRemoved0(ChannelHandlerContext ctx) throws java.lang.Exception
Description copied from class:ByteToMessageDecoderGets called after theByteToMessageDecoderwas removed from the actual context and it doesn't handle events anymore.- Overrides:
handlerRemoved0in classByteToMessageDecoder- Throws:
java.lang.Exception
-
readGZIPHeader
private boolean readGZIPHeader(ByteBuf in)
-
readGZIPFooter
private boolean readGZIPFooter(ByteBuf buf)
-
verifyCrc
private void verifyCrc(ByteBuf in)
-
looksLikeZlib
private static boolean looksLikeZlib(short cmf_flg)
-
-