Modifier and Type	Class and Description
private static enum	JdkZlibDecoder.GzipState

Modifier and Type	Field and Description
private final ByteBufChecksum	crc
private boolean	decideZlibOrNone
private final boolean	decompressConcatenated
private final byte[]	dictionary
private static final int	FCOMMENT
private static final int	FEXTRA
private static final int	FHCRC
private volatile boolean	finished
private int	flags
private static final int	FNAME
private static final int	FRESERVED
private JdkZlibDecoder.GzipState	gzipState
private Inflater	inflater
private int	xlen

Constructor Summary

Access	Constructor and Description
public	JdkZlibDecoder() Creates a new instance with the default wrapper (`ZlibWrapper#ZLIB`).
public	JdkZlibDecoder(int Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the `ByteBufAllocator`. maxAllocation) Creates a new instance with the default wrapper (`ZlibWrapper#ZLIB`) and the specified maximum buffer allocation.
public	JdkZlibDecoder(byte[] dictionary) Creates a new instance with the specified preset dictionary.
public	JdkZlibDecoder(byte[] dictionary, int Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the `ByteBufAllocator`. maxAllocation) Creates a new instance with the specified preset dictionary and maximum buffer allocation.
public	JdkZlibDecoder(ZlibWrapper wrapper) Creates a new instance with the specified wrapper.
public	JdkZlibDecoder(ZlibWrapper wrapper, int Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the `ByteBufAllocator`. maxAllocation) Creates a new instance with the specified wrapper and maximum buffer allocation.
public	JdkZlibDecoder(ZlibWrapper wrapper, boolean decompressConcatenated)
public	JdkZlibDecoder(ZlibWrapper wrapper, boolean decompressConcatenated, int maxAllocation)
public	JdkZlibDecoder(boolean decompressConcatenated)
public	JdkZlibDecoder(boolean decompressConcatenated, int maxAllocation)
private	JdkZlibDecoder(ZlibWrapper wrapper, byte[] dictionary, boolean decompressConcatenated, int maxAllocation)

Method Summary

Modifier and Type	Method and Description
protected void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to ctx, ByteBuf the `ByteBuf` from which to read data in, List<Object> the `List` to which decoded messages should be added out) Implements abstract io.netty.handler.codec.ByteToMessageDecoder.decode. Decode the from one `ByteBuf` to an other.
protected void	decompressionBufferExhausted(ByteBuf buffer) Overrides io.netty.handler.codec.compression.ZlibDecoder.decompressionBufferExhausted. Called when the decompression buffer cannot be expanded further.
private boolean	handleGzipFooter(ByteBuf in)
protected void	handlerRemoved0(ChannelHandlerContext ctx) Overrides io.netty.handler.codec.ByteToMessageDecoder.handlerRemoved0. Gets called after the `ByteToMessageDecoder` was removed from the actual context and it doesn't handle events anymore.
public boolean	isClosed() Implements abstract io.netty.handler.codec.compression.ZlibDecoder.isClosed. Returns `true` if and only if the end of the compressed stream has been reached.
private static boolean	looksLikeZlib(short cmf_flg)
private boolean	Returns: `true` if the footer could be read, `false` if the read could not be performed as the input `ByteBuf` doesn't have enough readable bytes (8 bytes). readGZIPFooter(ByteBuf the input. in) Read the GZIP footer.
private boolean	readGZIPHeader(ByteBuf in)
private boolean	Returns: `true` if the operation is complete and we can move to the next state, `false` if we need the retry again once we have more readable bytes. skipIfNeeded(ByteBuf the input in, int the mask that should be present in the `flags` when we need to skip bytes. flagMask) Skip bytes in the input if needed until we find the end marker `0x00`.
private boolean	Returns: `true` if verification could be performed, `false` if verification could not be performed as the input `ByteBuf` doesn't have enough readable bytes (4 bytes). verifyCrc(ByteBuf the input. in) Verifies CRC.
private boolean	verifyCrc16(ByteBuf in)

Inherited from io.netty.handler.codec.compression.ZlibDecoder:: prepareDecompressBuffer

Field Detail

crc	back to summary
private final ByteBufChecksum crc

decideZlibOrNone	back to summary
private boolean decideZlibOrNone

decompressConcatenated	back to summary
private final boolean decompressConcatenated

dictionary	back to summary
private final byte[] dictionary

FCOMMENT	back to summary
private static final int FCOMMENT

FEXTRA	back to summary
private static final int FEXTRA

FHCRC	back to summary
private static final int FHCRC

finished	back to summary
private volatile boolean finished

flags	back to summary
private int flags

FNAME	back to summary
private static final int FNAME

FRESERVED	back to summary
private static final int FRESERVED

gzipState	back to summary
private JdkZlibDecoder.GzipState gzipState

inflater	back to summary
private Inflater inflater

xlen	back to summary
private int xlen

Constructor Detail

JdkZlibDecoder	back to summary
public JdkZlibDecoder() Creates a new instance with the default wrapper (`ZlibWrapper#ZLIB`).

JdkZlibDecoder back to summary

JdkZlibDecoder	back to summary
public JdkZlibDecoder(int maxAllocation) Creates a new instance with the default wrapper (`ZlibWrapper#ZLIB`) and the specified maximum buffer allocation. Parameters maxAllocation:int Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the `ByteBufAllocator`.

public JdkZlibDecoder(int maxAllocation)

Creates a new instance with the default wrapper (ZlibWrapper#ZLIB) and the specified maximum buffer allocation.

Parameters

maxAllocation:int: Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the ByteBufAllocator.

JdkZlibDecoder	back to summary
public JdkZlibDecoder(byte[] dictionary) Creates a new instance with the specified preset dictionary. The wrapper is always `ZlibWrapper#ZLIB` because it is the only format that supports the preset dictionary.

JdkZlibDecoder back to summary

JdkZlibDecoder	back to summary
public JdkZlibDecoder(byte[] dictionary, int maxAllocation) Creates a new instance with the specified preset dictionary and maximum buffer allocation. The wrapper is always `ZlibWrapper#ZLIB` because it is the only format that supports the preset dictionary. Parameters maxAllocation:int Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the `ByteBufAllocator`.

public JdkZlibDecoder(byte[] dictionary, int maxAllocation)

Creates a new instance with the specified preset dictionary and maximum buffer allocation. The wrapper is always ZlibWrapper#ZLIB because it is the only format that supports the preset dictionary.

Parameters

maxAllocation:int: Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the ByteBufAllocator.

JdkZlibDecoder	back to summary
public JdkZlibDecoder(ZlibWrapper wrapper) Creates a new instance with the specified wrapper. Be aware that only `ZlibWrapper#GZIP`, `ZlibWrapper#ZLIB` and `ZlibWrapper#NONE` are supported atm.

JdkZlibDecoder back to summary

JdkZlibDecoder	back to summary
public JdkZlibDecoder(ZlibWrapper wrapper, int maxAllocation) Creates a new instance with the specified wrapper and maximum buffer allocation. Be aware that only `ZlibWrapper#GZIP`, `ZlibWrapper#ZLIB` and `ZlibWrapper#NONE` are supported atm. Parameters maxAllocation:int Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the `ByteBufAllocator`.

public JdkZlibDecoder(ZlibWrapper wrapper, int maxAllocation)

Creates a new instance with the specified wrapper and maximum buffer allocation. Be aware that only ZlibWrapper#GZIP, ZlibWrapper#ZLIB and ZlibWrapper#NONE are supported atm.

Parameters

maxAllocation:int: Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the ByteBufAllocator.

JdkZlibDecoder	back to summary
public JdkZlibDecoder(ZlibWrapper wrapper, boolean decompressConcatenated)

JdkZlibDecoder	back to summary
public JdkZlibDecoder(ZlibWrapper wrapper, boolean decompressConcatenated, int maxAllocation)

JdkZlibDecoder	back to summary
public JdkZlibDecoder(boolean decompressConcatenated)

JdkZlibDecoder	back to summary
public JdkZlibDecoder(boolean decompressConcatenated, int maxAllocation)

JdkZlibDecoder	back to summary
private JdkZlibDecoder(ZlibWrapper wrapper, byte[] dictionary, boolean decompressConcatenated, int maxAllocation)

Method Detail

decode back to summary

decode	back to summary
protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception Implements abstract io.netty.handler.codec.ByteToMessageDecoder.decode. Doc from io.netty.handler.codec.ByteToMessageDecoder.decode. Decode the from one `ByteBuf` to an other. This method will be called till either the input `ByteBuf` has nothing to read when return from this method or till nothing was read from the input `ByteBuf`. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to in:ByteBuf the `ByteBuf` from which to read data out:List<Object> the `List` to which decoded messages should be added Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception

Implements abstract io.netty.handler.codec.ByteToMessageDecoder.decode.

Doc from io.netty.handler.codec.ByteToMessageDecoder.decode.

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read when return from this method or till nothing was read from the input ByteBuf.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this ByteToMessageDecoder belongs to
in:ByteBuf: the ByteBuf from which to read data
out:List<Object>: the List to which decoded messages should be added

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

decompressionBufferExhausted back to summary

decompressionBufferExhausted	back to summary
protected void decompressionBufferExhausted(ByteBuf buffer) Overrides io.netty.handler.codec.compression.ZlibDecoder.decompressionBufferExhausted. Doc from io.netty.handler.codec.compression.ZlibDecoder.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 the `DecompressionException` is thrown, such as log the data that was decompressed so far. Annotations @Override

protected void decompressionBufferExhausted(ByteBuf buffer)

Overrides io.netty.handler.codec.compression.ZlibDecoder.decompressionBufferExhausted.

Doc from io.netty.handler.codec.compression.ZlibDecoder.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 the DecompressionException is thrown, such as log the data that was decompressed so far.

Annotations

@Override

handleGzipFooter	back to summary
private boolean handleGzipFooter(ByteBuf in)

handlerRemoved0 back to summary

handlerRemoved0	back to summary
protected void handlerRemoved0(ChannelHandlerContext ctx) throws Exception Overrides io.netty.handler.codec.ByteToMessageDecoder.handlerRemoved0. Doc from io.netty.handler.codec.ByteToMessageDecoder.handlerRemoved0. Gets called after the `ByteToMessageDecoder` was removed from the actual context and it doesn't handle events anymore. Annotations @Override

protected void handlerRemoved0(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.handler.codec.ByteToMessageDecoder.handlerRemoved0.

Doc from io.netty.handler.codec.ByteToMessageDecoder.handlerRemoved0.

Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.

Annotations

@Override

isClosed back to summary

isClosed	back to summary
public boolean isClosed() Implements abstract io.netty.handler.codec.compression.ZlibDecoder.isClosed. Doc from io.netty.handler.codec.compression.ZlibDecoder.isClosed. Returns `true` if and only if the end of the compressed stream has been reached. Annotations @Override

public boolean isClosed()

Implements abstract io.netty.handler.codec.compression.ZlibDecoder.isClosed.

Doc from io.netty.handler.codec.compression.ZlibDecoder.isClosed.

Returns true if and only if the end of the compressed stream has been reached.

Annotations

@Override

looksLikeZlib	back to summary
private static boolean looksLikeZlib(short cmf_flg)

readGZIPFooter back to summary

readGZIPFooter	back to summary
private boolean readGZIPFooter(ByteBuf in) Read the GZIP footer. Parameters in:ByteBuf the input. Returns:boolean `true` if the footer could be read, `false` if the read could not be performed as the input `ByteBuf` doesn't have enough readable bytes (8 bytes).

private boolean readGZIPFooter(ByteBuf in)

Read the GZIP footer.

Parameters

in:ByteBuf: the input.

Returns:boolean

true if the footer could be read, false if the read could not be performed as the input ByteBuf doesn't have enough readable bytes (8 bytes).

readGZIPHeader	back to summary
private boolean readGZIPHeader(ByteBuf in)

skipIfNeeded back to summary

skipIfNeeded	back to summary
private boolean skipIfNeeded(ByteBuf in, int flagMask) Skip bytes in the input if needed until we find the end marker `0x00`. Parameters in:ByteBuf the input flagMask:int the mask that should be present in the `flags` when we need to skip bytes. Returns:boolean `true` if the operation is complete and we can move to the next state, `false` if we need the retry again once we have more readable bytes.

private boolean skipIfNeeded(ByteBuf in, int flagMask)

Skip bytes in the input if needed until we find the end marker 0x00.

Parameters

in:ByteBuf: the input
flagMask:int: the mask that should be present in the flags when we need to skip bytes.

Returns:boolean

true if the operation is complete and we can move to the next state, false if we need the retry again once we have more readable bytes.

verifyCrc back to summary

verifyCrc	back to summary
private boolean verifyCrc(ByteBuf in) Verifies CRC. Parameters in:ByteBuf the input. Returns:boolean `true` if verification could be performed, `false` if verification could not be performed as the input `ByteBuf` doesn't have enough readable bytes (4 bytes).

private boolean verifyCrc(ByteBuf in)

Verifies CRC.

Parameters

in:ByteBuf: the input.

Returns:boolean

true if verification could be performed, false if verification could not be performed as the input ByteBuf doesn't have enough readable bytes (4 bytes).

verifyCrc16	back to summary
private boolean verifyCrc16(ByteBuf in)

io.netty.handler.codec.compression back to summary

private final Enum JdkZlibDecoder.GzipState

Class Inheritance

extends Enum<JdkZlibDecoder.GzipState>

java.lang.Object
java.lang.Enum
io.netty.handler.codec.compression.JdkZlibDecoder.GzipState

Field Summary

Modifier and Type	Field and Description
public static final JdkZlibDecoder.GzipState	FLG_READ
public static final JdkZlibDecoder.GzipState	FOOTER_START
public static final JdkZlibDecoder.GzipState	HEADER_END
public static final JdkZlibDecoder.GzipState	HEADER_START
public static final JdkZlibDecoder.GzipState	PROCESS_FHCRC
public static final JdkZlibDecoder.GzipState	SKIP_COMMENT
public static final JdkZlibDecoder.GzipState	SKIP_FNAME
public static final JdkZlibDecoder.GzipState	XLEN_READ

Constructor Summary

Access	Constructor and Description
private	GzipState()

Method Summary

Modifier and Type	Method and Description
public static JdkZlibDecoder.GzipState	valueOf(String name)
public static JdkZlibDecoder.GzipState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

FLG_READ	back to summary
public static final JdkZlibDecoder.GzipState FLG_READ

FOOTER_START	back to summary
public static final JdkZlibDecoder.GzipState FOOTER_START

HEADER_END	back to summary
public static final JdkZlibDecoder.GzipState HEADER_END

HEADER_START	back to summary
public static final JdkZlibDecoder.GzipState HEADER_START

PROCESS_FHCRC	back to summary
public static final JdkZlibDecoder.GzipState PROCESS_FHCRC

SKIP_COMMENT	back to summary
public static final JdkZlibDecoder.GzipState SKIP_COMMENT

SKIP_FNAME	back to summary
public static final JdkZlibDecoder.GzipState SKIP_FNAME

XLEN_READ	back to summary
public static final JdkZlibDecoder.GzipState XLEN_READ

Constructor Detail

GzipState	back to summary
private GzipState()

Method Detail

valueOf	back to summary
public static JdkZlibDecoder.GzipState valueOf(String name)

values	back to summary
public static JdkZlibDecoder.GzipState[] values()

public Class JdkZlibDecoder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum JdkZlibDecoder.GzipState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail