Class SnappyFrameDecompressor

java.lang.Object

io.netty.handler.codec.compression.InputBufferingDecompressor

io.netty.handler.codec.compression.SnappyFrameDecompressor

All Implemented Interfaces:

Decompressor, AutoCloseable

@UnstableApi
public final class SnappyFrameDecompressor
extends InputBufferingDecompressor

Uncompresses a ByteBuf encoded with the Snappy framing format. See Snappy framing format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SnappyFrameDecompressor.Builder
private static enum	SnappyFrameDecompressor.ChunkType

Nested classes/interfaces inherited from interface Decompressor

Decompressor.AbstractDecompressorBuilder, Decompressor.Status

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	eof
private static final int	MAX_COMPRESSED_CHUNK_SIZE
private static final int	MAX_DECOMPRESSED_DATA_SIZE
private static final int	MAX_UNCOMPRESSED_DATA_SIZE
private static final int	MIN_COMPRESSED_CHUNK_SIZE
private static final int	MIN_UNCOMPRESSED_DATA_SIZE
private int	numBytesToSkip
private ByteBuf	pendingOutput
private final Snappy	snappy
private static final int	SNAPPY_IDENTIFIER_LEN
private boolean	started
private final boolean	validateChecksums

Fields inherited from class InputBufferingDecompressor

allocator

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SnappyFrameDecompressor.Builder	builder()
private static void	checkByte(byte actual, byte expect)
void	close()	Close this decompressor, cleaning up any associated resources.
void	endOfInput()	Notify the decompressor that the end of input has been reached.
private static SnappyFrameDecompressor.ChunkType	mapChunkType(byte type)	Decodes the chunk type from the type tag byte.
(package private) void	processInput(ByteBuf in)	Process some input.
(package private) ByteBuf	processOutput(ByteBuf buf)	Produce some output.
Decompressor.Status	status()	Get the current status.

Methods inherited from class InputBufferingDecompressor

addInput, available, takeOutput

Methods inherited from class Object

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

Field Details

SNAPPY_IDENTIFIER_LEN

private static final int SNAPPY_IDENTIFIER_LEN

See Also:

• Constant Field Values

MAX_UNCOMPRESSED_DATA_SIZE

private static final int MAX_UNCOMPRESSED_DATA_SIZE

See Also:

• Constant Field Values

MIN_UNCOMPRESSED_DATA_SIZE

private static final int MIN_UNCOMPRESSED_DATA_SIZE

See Also:

• Constant Field Values

MAX_DECOMPRESSED_DATA_SIZE

private static final int MAX_DECOMPRESSED_DATA_SIZE

See Also:

• Constant Field Values

MAX_COMPRESSED_CHUNK_SIZE

private static final int MAX_COMPRESSED_CHUNK_SIZE

See Also:

• Constant Field Values

MIN_COMPRESSED_CHUNK_SIZE

private static final int MIN_COMPRESSED_CHUNK_SIZE

See Also:

• Constant Field Values

snappy

private final Snappy snappy

validateChecksums

private final boolean validateChecksums

started

private boolean started

numBytesToSkip

private int numBytesToSkip

pendingOutput

private ByteBuf pendingOutput

eof

private boolean eof

Constructor Details

SnappyFrameDecompressor

SnappyFrameDecompressor(SnappyFrameDecompressor.Builder builder,
 ByteBufAllocator allocator)

Method Details

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 AutoCloseable

Specified by:

close in interface Decompressor

Overrides:

close in class InputBufferingDecompressor

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

processInput

void processInput(ByteBuf in)
           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:

in - The input buffer

Throws:

DecompressionException

processOutput

ByteBuf processOutput(ByteBuf buf)
               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:

buf - The input buffer

Throws:

DecompressionException

checkByte

private static void checkByte(byte actual,
 byte expect)

mapChunkType

private static SnappyFrameDecompressor.ChunkType mapChunkType(byte type)

Decodes the chunk type from the type tag byte.

Parameters:

type - The tag byte extracted from the stream

Returns:

The appropriate SnappyFrameDecompressor.ChunkType, defaulting to SnappyFrameDecompressor.ChunkType.RESERVED_UNSKIPPABLE

builder

@UnstableApi
public static SnappyFrameDecompressor.Builder builder()