Nested and Inner Type Summary

Modifier and Type	Class and Description
private static enum	ZlibCompressor.State

Field Summary

Modifier and Type	Field and Description
private final CRC32	crc
private final Deflater	deflater
private static final byte[]	gzipHeader
private static final InternalLogger	logger
private static final int	MAX_INITIAL_OUTPUT_BUFFER_SIZE Maximum initial size for temporary heap buffers used for the compressed output.
private ZlibCompressor.State	state
private final ZlibWrapper	wrapper
private boolean	writeHeader

Constructor Summary

Access	Constructor and Description
private	ZlibCompressor(ZlibWrapper wrapper, int compressionLevel)
private	ZlibCompressor(int compressionLevel, byte[] dictionary)

Method Summary

Modifier and Type	Method and Description
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. uncompressed, 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 Buffer	compressData(Buffer uncompressed, BufferAllocator allocator)
private void	compressData(ByteBuffer in, Buffer out)
private void	deflate(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<ZlibCompressor>	Returns: the factory. newFactory() Creates a zlib compressor factory with the default compression level (`6`) and the default wrapper (`ZlibWrapper#ZLIB`).
public static Supplier<ZlibCompressor>	newFactory(int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. compressionLevel) Creates a zlib compressor factory with the specified `compressionLevel` and the default wrapper (`ZlibWrapper#ZLIB`).
public static Supplier<ZlibCompressor>	Returns: the factory. newFactory(ZlibWrapper wrapper) Creates a zlib compressor factory with the default compression level (`6`) and the specified wrapper.
public static Supplier<ZlibCompressor>	Returns: the factory. newFactory(ZlibWrapper wrapper, int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. compressionLevel) Creates a zlib compressor factory with the specified `compressionLevel` and the specified wrapper.
public static Supplier<ZlibCompressor>	Returns: the factory. newFactory(byte[] the preset dictionary dictionary) Creates a zlib compressor factory with the default compression level (`6`) and the specified preset dictionary.
public static Supplier<ZlibCompressor>	Returns: the factory. newFactory(int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. compressionLevel, byte[] the preset dictionary dictionary) Creates a zlib compressor factory with the specified `compressionLevel` and the specified preset dictionary.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

crc	back to summary
private final CRC32 crc

deflater	back to summary
private final Deflater deflater

gzipHeader	back to summary
private static final byte[] gzipHeader

logger	back to summary
private static final InternalLogger logger

MAX_INITIAL_OUTPUT_BUFFER_SIZE	back to summary
private static final int MAX_INITIAL_OUTPUT_BUFFER_SIZE Maximum initial size for temporary heap buffers used for the compressed output. Buffer may still grow beyond this if necessary.

state	back to summary
private ZlibCompressor.State state

wrapper	back to summary
private final ZlibWrapper wrapper

wrapper

back to summary

private final ZlibWrapper wrapper

writeHeader	back to summary
private boolean writeHeader

Constructor Detail

ZlibCompressor	back to summary
private ZlibCompressor(ZlibWrapper wrapper, int compressionLevel)

ZlibCompressor	back to summary
private ZlibCompressor(int compressionLevel, byte[] dictionary)

Method Detail

close back to summary

close	back 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

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

compress back to summary

compress	back to summary
public Buffer compress(Buffer uncompressed, 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 uncompressed: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.

public Buffer compress(Buffer uncompressed, 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

uncompressed: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.

compressData	back to summary
private Buffer compressData(Buffer uncompressed, BufferAllocator allocator)

compressData	back to summary
private void compressData(ByteBuffer in, Buffer out)

deflate	back to summary
private void deflate(Buffer out)

finish back to summary

finish	back 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

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

isClosed back to summary

isClosed	back 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

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

isFinished back to summary

isFinished	back 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

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

newFactory back to summary

newFactory	back to summary
public static Supplier<ZlibCompressor> newFactory() Creates a zlib compressor factory with the default compression level (`6`) and the default wrapper (`ZlibWrapper#ZLIB`). Returns:Supplier<ZlibCompressor> the factory. Exceptions CompressionException: if failed to initialize zlib

public static Supplier<ZlibCompressor> newFactory()

Creates a zlib compressor factory with the default compression level (6) and the default wrapper (ZlibWrapper#ZLIB).

Returns:Supplier<ZlibCompressor>

the factory.

Exceptions

CompressionException:: if failed to initialize zlib

newFactory back to summary

newFactory	back to summary
public static Supplier<ZlibCompressor> newFactory(int compressionLevel) Creates a zlib compressor factory with the specified `compressionLevel` and the default wrapper (`ZlibWrapper#ZLIB`). Parameters compressionLevel:int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. Exceptions CompressionException: if failed to initialize zlib

public static Supplier<ZlibCompressor> newFactory(int compressionLevel)

Creates a zlib compressor factory with the specified compressionLevel and the default wrapper (ZlibWrapper#ZLIB).

Parameters

compressionLevel:int: 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.

Exceptions

CompressionException:: if failed to initialize zlib

newFactory back to summary

newFactory	back to summary
public static Supplier<ZlibCompressor> newFactory(ZlibWrapper wrapper) Creates a zlib compressor factory with the default compression level (`6`) and the specified wrapper. Returns:Supplier<ZlibCompressor> the factory. Exceptions CompressionException: if failed to initialize zlib

public static Supplier<ZlibCompressor> newFactory(ZlibWrapper wrapper)

Creates a zlib compressor factory with the default compression level (6) and the specified wrapper.

Returns:Supplier<ZlibCompressor>

the factory.

Exceptions

CompressionException:: if failed to initialize zlib

newFactory back to summary

newFactory	back to summary
public static Supplier<ZlibCompressor> newFactory(ZlibWrapper wrapper, int compressionLevel) Creates a zlib compressor factory with the specified `compressionLevel` and the specified wrapper. Parameters compressionLevel:int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. Returns:Supplier<ZlibCompressor> the factory. Exceptions CompressionException: if failed to initialize zlib

public static Supplier<ZlibCompressor> newFactory(ZlibWrapper wrapper, int compressionLevel)

Creates a zlib compressor factory with the specified compressionLevel and the specified wrapper.

Parameters

compressionLevel:int: 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.

Returns:Supplier<ZlibCompressor>

the factory.

Exceptions

CompressionException:: if failed to initialize zlib

newFactory back to summary

newFactory	back to summary
public static Supplier<ZlibCompressor> newFactory(byte[] dictionary) Creates a zlib compressor factory with the default compression level (`6`) and the specified preset dictionary. The wrapper is always `ZlibWrapper#ZLIB` because it is the only format that supports the preset dictionary. Parameters dictionary:byte[] the preset dictionary Returns:Supplier<ZlibCompressor> the factory. Exceptions CompressionException: if failed to initialize zlib

public static Supplier<ZlibCompressor> newFactory(byte[] dictionary)

Creates a zlib compressor factory with the default compression level (6) and the specified preset dictionary. The wrapper is always ZlibWrapper#ZLIB because it is the only format that supports the preset dictionary.

Parameters

dictionary:byte[]: the preset dictionary

Returns:Supplier<ZlibCompressor>

the factory.

Exceptions

CompressionException:: if failed to initialize zlib

newFactory back to summary

newFactory	back to summary
public static Supplier<ZlibCompressor> newFactory(int compressionLevel, byte[] dictionary) Creates a zlib compressor factory with the specified `compressionLevel` and the specified preset dictionary. The wrapper is always `ZlibWrapper#ZLIB` because it is the only format that supports the preset dictionary. Parameters compressionLevel:int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. dictionary:byte[] the preset dictionary Returns:Supplier<ZlibCompressor> the factory. Exceptions CompressionException: if failed to initialize zlib

public static Supplier<ZlibCompressor> newFactory(int compressionLevel, byte[] dictionary)

Creates a zlib compressor factory with the specified compressionLevel and the specified preset dictionary. The wrapper is always ZlibWrapper#ZLIB because it is the only format that supports the preset dictionary.

Parameters

compressionLevel:int: 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.
dictionary:byte[]: the preset dictionary

Returns:Supplier<ZlibCompressor>

the factory.

Exceptions

CompressionException:: if failed to initialize zlib

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

private final Enum ZlibCompressor.State

Class Inheritance

extends Enum<ZlibCompressor.State>

java.lang.Object
java.lang.Enum
io.netty5.handler.codec.compression.ZlibCompressor.State

Field Summary

Modifier and Type	Field and Description
public static final ZlibCompressor.State	CLOSED
public static final ZlibCompressor.State	FINISHED
public static final ZlibCompressor.State	PROCESSING

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

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

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

Field Detail

CLOSED	back to summary
public static final ZlibCompressor.State CLOSED

FINISHED	back to summary
public static final ZlibCompressor.State FINISHED

PROCESSING	back to summary
public static final ZlibCompressor.State PROCESSING

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static ZlibCompressor.State valueOf(String name)

values	back to summary
public static ZlibCompressor.State[] values()

public final Class ZlibCompressor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum ZlibCompressor.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail