Class ZstdDecompressor

java.lang.Object

io.netty.handler.codec.compression.ZstdDecompressor

All Implemented Interfaces:

Decompressor, AutoCloseable

@UnstableApi
public final class ZstdDecompressor
extends Object
implements Decompressor

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ZstdDecompressor.Builder

Nested classes/interfaces inherited from interface Decompressor

Decompressor.AbstractDecompressorBuilder, Decompressor.Status

Modifier and Type	Interface	Description
static class	Decompressor.AbstractDecompressorBuilder
static enum	Decompressor.Status	Current status of the decompressor.

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 decompressor.

Method Summary

Modifier and Type	Method	Description
void	addInput(ByteBuf buf)	Add a new input buffer.
static ZstdDecompressor.Builder	builder()
void	close()	Close this decompressor, cleaning up any associated resources.
void	endOfInput()	Notify the decompressor that the end of input has been reached.
Decompressor.Status	status()	Get the current status.
ByteBuf	takeOutput()	Take a decompressed buffer from this decompressor.

Methods inherited from class Object

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

Field Details

DEFAULT_MAX_WINDOW_LOG

public static final int DEFAULT_MAX_WINDOW_LOG

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

See Also:

• Constant Field Values

Method Details

status

public Decompressor.Status status()
                           throws DecompressionException

Description copied from interface: Decompressor

Get the current status. Like the other operations on this class, calling this method is not permitted if the decompressor has failed or was closed.

Specified by:

status in interface Decompressor

Returns:

The current status

Throws:

DecompressionException

addInput

public void addInput(ByteBuf buf)
              throws DecompressionException

Description copied from interface: Decompressor

Add a new input buffer. Only permitted for Decompressor.Status.NEED_INPUT.

Specified by:

addInput in interface Decompressor

Parameters:

buf - The input buffer. Buffer ownership transfers to the decompressor (also on exception).

Throws:

DecompressionException

endOfInput

public void endOfInput()
                throws DecompressionException

Description copied from interface: Decompressor

Notify the decompressor that the end of input has been reached. Some implementations may flush remaining data or throw an exception if the input is truncated, but most implementations do nothing. Only permitted for Decompressor.Status.NEED_INPUT.

Specified by:

endOfInput in interface Decompressor

Throws:

DecompressionException

takeOutput

public ByteBuf takeOutput()
                   throws DecompressionException

Description copied from interface: Decompressor

Take a decompressed buffer from this decompressor. Only permitted for Decompressor.Status.NEED_OUTPUT. Buffer ownership transfers to the caller.

Specified by:

takeOutput in interface Decompressor

Returns:

The decompressed buffer. May be empty.

Throws:

DecompressionException

close

public void close()

Description copied from interface: Decompressor

Close this decompressor, cleaning up any associated resources. This method is idempotent.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Decompressor

builder

@UnstableApi
public static ZstdDecompressor.Builder builder()