Class InputBufferingDecompressor

java.lang.Object

io.netty.handler.codec.compression.InputBufferingDecompressor

All Implemented Interfaces:

Decompressor, java.lang.AutoCloseable

Direct Known Subclasses:

Bzip2Decompressor, FastLzFrameDecompressor, JdkZlibDecompressor, SnappyFrameDecompressor

abstract class InputBufferingDecompressor
extends java.lang.Object
implements Decompressor

Special decompressor implementation that buffers input so that it can be processed piecemeal, similar to ByteToMessageDecoder.

Nested Class Summary

Nested classes/interfaces inherited from interface Decompressor

Decompressor.AbstractDecompressorBuilder, Decompressor.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected final ByteBufAllocator	allocator
private ByteBuf	cumulation

Constructor Summary

Constructors

Constructor	Description
InputBufferingDecompressor(ByteBufAllocator allocator)

Method Summary

Modifier and Type	Method	Description
final void	addInput(ByteBuf buf)	Add a new input buffer.
(package private) final int	available()	Number of buffered bytes.
void	close()	Close this decompressor, cleaning up any associated resources.
(package private) abstract void	processInput(ByteBuf buf)	Process some input.
(package private) abstract ByteBuf	processOutput(ByteBuf buf)	Produce some output.
final ByteBuf	takeOutput()	Take a decompressed buffer from this decompressor.

Methods inherited from class java.lang.Object

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

Methods inherited from interface Decompressor

endOfInput, status

Field Details

allocator

protected final ByteBufAllocator allocator

cumulation

private ByteBuf cumulation

Constructor Details

InputBufferingDecompressor

InputBufferingDecompressor(ByteBufAllocator allocator)

Method Details

addInput

public final 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

takeOutput

public final 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

processInput

abstract void processInput(ByteBuf buf)
                    throws DecompressionException

Process some input. The input buffer ownership does not transfer to this method: If there's still data unread after this method finishes, it will be buffered.

Parameters:

buf - The input buffer

Throws:

DecompressionException

processOutput

abstract ByteBuf processOutput(ByteBuf buf)
                        throws DecompressionException

Produce some output. The input buffer parameter may be read from to consume some more data, but note that this method must return a buffer even if the input is too short.

Parameters:

buf - The input buffer

Throws:

DecompressionException

available

final int available()

Number of buffered bytes.

Returns:

Number of buffered bytes

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 java.lang.AutoCloseable

Specified by:

close in interface Decompressor