Class FastLzFrameDecompressor

java.lang.Object

io.netty.handler.codec.compression.InputBufferingDecompressor

io.netty.handler.codec.compression.FastLzFrameDecompressor

All Implemented Interfaces:

Decompressor, AutoCloseable

@UnstableApi
public final class FastLzFrameDecompressor
extends InputBufferingDecompressor

Uncompresses a ByteBuf encoded by FastLzFrameEncoder using the FastLZ algorithm. See FastLZ format.

This API is still in progress as part of the decompression migration tracked by #16743.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FastLzFrameDecompressor.Builder
private static enum	FastLzFrameDecompressor.State	Current state of decompression.

Nested classes/interfaces inherited from interface Decompressor

Decompressor.AbstractDecompressorBuilder, Decompressor.Status

Field Summary

Fields

Modifier and Type	Field	Description
private final ByteBufChecksum	checksum	Underlying checksum calculator in use.
private int	chunkLength	Length of the current received chunk of data.
private int	currentChecksum	Checksum value of the current received chunk of data when present.
private FastLzFrameDecompressor.State	currentState
private boolean	hasChecksum	Indicates whether this chunk has a checksum.
private boolean	isCompressed	Indicates whether this chunk is compressed.
private int	originalLength	Original length of the current received chunk of data.

Fields inherited from class InputBufferingDecompressor

allocator

Constructor Summary

Constructors

Constructor	Description
FastLzFrameDecompressor(FastLzFrameDecompressor.Builder builder, ByteBufAllocator allocator)

Method Summary

Modifier and Type	Method	Description
static FastLzFrameDecompressor.Builder	builder()
void	endOfInput()	Notify the decompressor that the end of input has been reached.
(package private) void	processInput(ByteBuf buf)	Process some input.
(package private) ByteBuf	processOutput(ByteBuf in)	Produce some output.
Decompressor.Status	status()	Get the current status.

Methods inherited from class InputBufferingDecompressor

addInput, available, close, takeOutput

Methods inherited from class Object

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

Field Details

currentState

private FastLzFrameDecompressor.State currentState

checksum

private final ByteBufChecksum checksum

Underlying checksum calculator in use.

chunkLength

private int chunkLength

Length of the current received chunk of data.

originalLength

private int originalLength

Original length of the current received chunk of data. It is equal to chunkLength for uncompressed chunks.

isCompressed

private boolean isCompressed

Indicates whether this chunk is compressed.

hasChecksum

private boolean hasChecksum

Indicates whether this chunk has a checksum.

currentChecksum

private int currentChecksum

Checksum value of the current received chunk of data when present.

Constructor Details

FastLzFrameDecompressor

FastLzFrameDecompressor(FastLzFrameDecompressor.Builder builder,
 ByteBufAllocator allocator)

Method Details

processInput

void processInput(ByteBuf buf)
           throws DecompressionException

Description copied from class: InputBufferingDecompressor

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.

Specified by:

processInput in class InputBufferingDecompressor

Parameters:

buf - The input buffer

Throws:

DecompressionException

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.

Returns:

The current status

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.

Throws:

DecompressionException

processOutput

ByteBuf processOutput(ByteBuf in)
               throws DecompressionException

Description copied from class: InputBufferingDecompressor

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.

Specified by:

processOutput in class InputBufferingDecompressor

Parameters:

in - The input buffer

Throws:

DecompressionException

builder

@UnstableApi
public static FastLzFrameDecompressor.Builder builder()