Top Description Inners Fields Constructors Methods
io.netty5.handler.codec.compression

public final Class ZstdCompressor

extends Object
implements Compressor
Class Inheritance
All Implemented Interfaces
io.netty5.handler.codec.compression.Compressor, java.lang.AutoCloseable
Imports
com.github.luben.zstd.Zstd, io.netty5.buffer.Buffer, .BufferAllocator, io.netty5.handler.codec.EncoderException, io.netty5.util.internal.ObjectUtil, java.nio.ByteBuffer, java.util.function.Supplier
Compresses a Buffer using the Zstandard algorithm. See Zstandard.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static enum
ZstdCompressor.State

Field Summary

Modifier and TypeField and Description
private final int
blockSize

private final int
compressionLevel

private final int
maxEncodeSize

private ZstdCompressor.State
state

Constructor Summary

AccessConstructor and Description
private
ZstdCompressor(int
specifies the level of the compression
compressionLevel, int
is used to calculate the compressionLevel
blockSize, int
specifies the size of the largest compressed object
maxEncodeSize)

Method Summary

Modifier and TypeMethod and Description
private Buffer
allocateBuffer(BufferAllocator allocator, Buffer msg)

public void
close()

Implements io.netty5.handler.codec.compression.Compressor.close.

# Close the compressor.
public Buffer
compress(Buffer
the Buffer that contains the data to be compressed.
in, BufferAllocator
the BufferAllocator that is used to allocate a new buffer (if needed) to write the compressed bytes too.
allocator)

Implements io.netty5.handler.codec.compression.Compressor.compress.

This method will read from the input Buffer and compress into a new Buffer that will be allocated (if needed) from the BufferAllocator.
private void
compressData(Buffer in, Buffer out)

public Buffer
finish(BufferAllocator allocator)

Implements io.netty5.handler.codec.compression.Compressor.finish.

By calling this method we signal that the compression stream is marked as finish.
public boolean
isClosed()

Implements io.netty5.handler.codec.compression.Compressor.isClosed.

Return true if the decompressor was closed, false otherwise.
public boolean
isFinished()

Implements io.netty5.handler.codec.compression.Compressor.isFinished.

Returns true if the compressor was finished or closed.
public static Supplier<ZstdCompressor>

Returns:

the factory.
newFactory()

Creates a new Zstd compressor factory.

public static Supplier<ZstdCompressor>

Returns:

the factory.
newFactory(int
specifies the level of the compression
compressionLevel)

Creates a new Zstd compressor factory.

public static Supplier<ZstdCompressor>

Returns:

the factory.
newFactory(int
is used to calculate the compressionLevel
blockSize, int
specifies the size of the largest compressed object
maxEncodeSize)

Creates a new Zstd compressor factory.

public static Supplier<ZstdCompressor>

Returns:

the factory.
newFactory(int
specifies the level of the compression
compressionLevel, int
is used to calculate the compressionLevel
blockSize, int
specifies the size of the largest compressed object
maxEncodeSize)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

blockSizeback to summary
private final int blockSize
compressionLevelback to summary
private final int compressionLevel
maxEncodeSizeback to summary
private final int maxEncodeSize
stateback to summary
private ZstdCompressor.State state

Constructor Detail

ZstdCompressorback to summary
private ZstdCompressor(int compressionLevel, int blockSize, int maxEncodeSize)
Parameters
compressionLevel:int

specifies the level of the compression

blockSize:int

is used to calculate the compressionLevel

maxEncodeSize:int

specifies the size of the largest compressed object

Method Detail

allocateBufferback to summary
private Buffer allocateBuffer(BufferAllocator allocator, Buffer msg)
closeback to summary
public void close()

Implements io.netty5.handler.codec.compression.Compressor.close.

Doc from io.netty5.handler.codec.compression.Compressor.close.

# Close the compressor. After this method was called isFinished() will return true as well and it is not allowed to call compress(Buffer, BufferAllocator) or finish(BufferAllocator) anymore -

Annotations
@Override
compressback to summary
public Buffer compress(Buffer in, BufferAllocator allocator) throws CompressionException

Implements io.netty5.handler.codec.compression.Compressor.compress.

Doc from io.netty5.handler.codec.compression.Compressor.compress.

This method will read from the input Buffer and compress into a new Buffer that will be allocated (if needed) from the BufferAllocator. This method is expected to consume all data from the input but not take ownership. The caller is responsible to release the input buffer after this method returns.

Parameters
in:Buffer

the Buffer that contains the data to be compressed.

allocator:BufferAllocator

the BufferAllocator that is used to allocate a new buffer (if needed) to write the compressed bytes too.

Returns:Buffer

the Buffer that contains the compressed data. The caller of this method takes ownership of the buffer. The return value will never be null.

Annotations
@Override
Exceptions
CompressionException:
thrown if an compression error was encountered or the compressor was closed already.
compressDataback to summary
private void compressData(Buffer in, Buffer out)
finishback to summary
public Buffer finish(BufferAllocator allocator)

Implements io.netty5.handler.codec.compression.Compressor.finish.

Doc from io.netty5.handler.codec.compression.Compressor.finish.

By calling this method we signal that the compression stream is marked as finish. The returned Buffer might contain a "trailer" which marks the end of the stream.

Returns:Buffer

the Buffer which represent the end of the compression stream, which might be empty if the compressor don't need a trailer to signal the end. The caller of this method takes ownership of the buffer. The return value will never be null.

Annotations
@Override
isClosedback to summary
public boolean isClosed()

Implements io.netty5.handler.codec.compression.Compressor.isClosed.

Doc from io.netty5.handler.codec.compression.Compressor.isClosed.

Return true if the decompressor was closed, false otherwise.

Returns:boolean

true if the decompressor was closed, false otherwise.

Annotations
@Override
isFinishedback to summary
public boolean isFinished()

Implements io.netty5.handler.codec.compression.Compressor.isFinished.

Doc from io.netty5.handler.codec.compression.Compressor.isFinished.

Returns true if the compressor was finished or closed. This might happen because someone explicit called finish(BufferAllocator) / close() or the compressor implementation did decide to close itself due a compression error which can't be recovered. After isFinished() returns true the compress(Buffer, BufferAllocator) method will just return an empty buffer without consuming anything from its input buffer.

Returns:boolean

true if the compressor was marked as finished, false otherwise.

Annotations
@Override
newFactoryback to summary
public static Supplier<ZstdCompressor> newFactory()

Creates a new Zstd compressor factory. Please note that if you use the default constructor, the default BLOCK_SIZE and MAX_BLOCK_SIZE will be used. If you want to specify BLOCK_SIZE and MAX_BLOCK_SIZE yourself, please use the newFactory(int, int) method.

Returns:Supplier<ZstdCompressor>

the factory.

newFactoryback to summary
public static Supplier<ZstdCompressor> newFactory(int compressionLevel)

Creates a new Zstd compressor factory.

Parameters
compressionLevel:int

specifies the level of the compression

Returns:Supplier<ZstdCompressor>

the factory.

newFactoryback to summary
public static Supplier<ZstdCompressor> newFactory(int blockSize, int maxEncodeSize)

Creates a new Zstd compressor factory.

Parameters
blockSize:int

is used to calculate the compressionLevel

maxEncodeSize:int

specifies the size of the largest compressed object

Returns:Supplier<ZstdCompressor>

the factory.

newFactoryback to summary
public static Supplier<ZstdCompressor> newFactory(int compressionLevel, int blockSize, int maxEncodeSize)
Parameters
compressionLevel:int

specifies the level of the compression

blockSize:int

is used to calculate the compressionLevel

maxEncodeSize:int

specifies the size of the largest compressed object

Returns:Supplier<ZstdCompressor>

the factory.

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

private final Enum ZstdCompressor.State

extends Enum<ZstdCompressor.State>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final ZstdCompressor.State
CLOSED

public static final ZstdCompressor.State
FINISHED

public static final ZstdCompressor.State
PROCESSING

Constructor Summary

AccessConstructor and Description
private
State()

Method Summary

Modifier and TypeMethod and Description
public static ZstdCompressor.State
valueOf(String name)

public static ZstdCompressor.State[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CLOSEDback to summary
public static final ZstdCompressor.State CLOSED
FINISHEDback to summary
public static final ZstdCompressor.State FINISHED
PROCESSINGback to summary
public static final ZstdCompressor.State PROCESSING

Constructor Detail

Stateback to summary
private State()

Method Detail

valueOfback to summary
public static ZstdCompressor.State valueOf(String name)
valuesback to summary
public static ZstdCompressor.State[] values()