Netty 5.0.0.Alpha5 · io.netty5.handler.codec.compression.Compressor

Method Summary

Modifier and Type	Method and Description
public void	close() Redeclares java.lang.AutoCloseable.close. # Close the compressor.
public Buffer	Returns: the `Buffer` that contains the compressed data. The caller of this method takes ownership of the buffer. The return value will never be `null`. compress(Buffer the `Buffer` that contains the data to be compressed. input, BufferAllocator the `BufferAllocator` that is used to allocate a new buffer (if needed) to write the compressed bytes too. allocator) This method will read from the input `Buffer` and compress into a new `Buffer` that will be allocated (if needed) from the `BufferAllocator`.
public Buffer	Returns: 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`. finish(BufferAllocator allocator) By calling this method we signal that the compression stream is marked as finish.
public boolean	Returns: `true` if the decompressor was closed, `false` otherwise. isClosed() Return `true` if the decompressor was closed, `false` otherwise.
public boolean	Returns: `true` if the compressor was marked as finished, `false` otherwise. isFinished() Returns true if the compressor was finished or closed.

Method Detail

close back to summary

close	back to summary
public void close() Redeclares java.lang.AutoCloseable.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()

Redeclares java.lang.AutoCloseable.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 input, BufferAllocator allocator) throws CompressionException 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 input: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`. Exceptions CompressionException: thrown if an compression error was encountered or the compressor was closed already.

public Buffer compress(Buffer input, BufferAllocator allocator) throws CompressionException

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

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

Exceptions

CompressionException:: thrown if an compression error was encountered or the compressor was closed already.

finish back to summary

finish	back to summary
public Buffer finish(BufferAllocator allocator) throws CompressionException 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`. Exceptions CompressionException: thrown if a compression error was encountered or the compressor was closed already.

public Buffer finish(BufferAllocator allocator) throws CompressionException

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.

Exceptions

CompressionException:: thrown if a compression error was encountered or the compressor was closed already.

isClosed back to summary

isClosed	back to summary
public boolean isClosed() Return `true` if the decompressor was closed, `false` otherwise. Returns:boolean `true` if the decompressor was closed, `false` otherwise.

public boolean isClosed()

Return true if the decompressor was closed, false otherwise.

Returns:boolean: true if the decompressor was closed, false otherwise.

isFinished back to summary

isFinished	back to summary
public boolean 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.

public boolean 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.

public Interface Compressor

Method Summary

Method Detail