Class ZstdDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.compression.ZstdDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public final class ZstdDecoder
extends ByteToMessageDecoder

Decompresses a compressed block ByteBuf using the Zstandard algorithm. See Zstandard.

Nested Class Summary

Nested classes/interfaces inherited from class ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_WINDOW_LOG	Default upper bound on the Window_Log accepted by the decoder.
static final int	DEFAULT_MAXIMUM_ALLOCATION_SIZE	Default maximum size of a single output buffer, in bytes (4 MiB).

Fields inherited from class ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor	Description
ZstdDecoder()	Creates a new decoder with the DEFAULT_MAXIMUM_ALLOCATION_SIZE, and the DEFAULT_MAX_WINDOW_LOG window log size.
ZstdDecoder(int maximumAllocationSize)	Creates a new decoder with the given maximum allocation size, and the DEFAULT_MAX_WINDOW_LOG window log size.
ZstdDecoder(int maximumAllocationSize, int maxWindowLog)	Creates a new decoder with an explicit upper bound on the accepted Window_Log.

Method Summary

Modifier and Type	Method	Description
void	channelReadComplete(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Decode the from one ByteBuf to an other.
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
protected void	handlerRemoved0(ChannelHandlerContext ctx)	Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.

Methods inherited from class ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelRead, decodeLast, discardSomeReadBytes, handlerRemoved, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_MAXIMUM_ALLOCATION_SIZE

public static final int DEFAULT_MAXIMUM_ALLOCATION_SIZE

Default maximum size of a single output buffer, in bytes (4 MiB).

See Also:

• Constant Field Values

DEFAULT_MAX_WINDOW_LOG

public static final int DEFAULT_MAX_WINDOW_LOG

Default upper bound on the Window_Log accepted by the decoder. 27 corresponds to a 128 MiB decompression window.

See Also:

• Constant Field Values

Constructor Details

ZstdDecoder

public ZstdDecoder()

Creates a new decoder with the DEFAULT_MAXIMUM_ALLOCATION_SIZE, and the DEFAULT_MAX_WINDOW_LOG window log size.

The window log size bounds the memory usage of the sliding window for ZSTD frame decompression. Frames declaring a larger window will be rejected to bound the memory the decoder may allocate per stream.

ZstdDecoder

public ZstdDecoder(int maximumAllocationSize)

Creates a new decoder with the given maximum allocation size, and the DEFAULT_MAX_WINDOW_LOG window log size.

The window log size bounds the memory usage of the sliding window for ZSTD frame decompression. Frames declaring a larger window will be rejected to bound the memory the decoder may allocate per stream.

Parameters:

maximumAllocationSize - maximum size of a single output buffer.

ZstdDecoder

public ZstdDecoder(int maximumAllocationSize,
 int maxWindowLog)

Creates a new decoder with an explicit upper bound on the accepted Window_Log.

Parameters:

maximumAllocationSize - maximum size of a single output buffer.

maxWindowLog - upper bound on the Window_Log field of incoming frames; must be in [10, 31]. Frames declaring a larger window will be rejected to bound the memory the decoder may allocate per stream.

Method Details

decode

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

Description copied from class: ByteToMessageDecoder

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.

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error occurs

channelReadComplete

public void channelReadComplete(ChannelHandlerContext ctx)
                         throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelReadComplete in interface ChannelInboundHandler

Overrides:

channelReadComplete in class ByteToMessageDecoder

Throws:

Exception

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws Exception

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

handlerAdded in interface ChannelHandler

Overrides:

handlerAdded in class ChannelHandlerAdapter

Throws:

Exception

handlerRemoved0

protected void handlerRemoved0(ChannelHandlerContext ctx)
                        throws Exception

Description copied from class: ByteToMessageDecoder

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

Overrides:

handlerRemoved0 in class ByteToMessageDecoder

Throws:

Exception