Package io.netty.handler.codec.compression

Class FastLzFrameDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.compression.FastLzFrameDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class FastLzFrameDecoder
extends ByteToMessageDecoder

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	FastLzFrameDecoder.State	Current state of decompression.

Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private final ByteBufChecksum	checksum	Underlying checksum calculator in use.
private int	chunkLength	Length of current received chunk of data.
private int	currentChecksum	Checksum value of current received chunk of data which has checksum.
private FastLzFrameDecoder.State	currentState
private boolean	hasChecksum	Indicates is this chunk has checksum or not.
private boolean	isCompressed	Indicates is this chunk compressed or not.
private int	originalLength	Original of current received chunk of data.

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor	Description
FastLzFrameDecoder()	Creates the fastest FastLZ decoder without checksum calculation.
FastLzFrameDecoder(boolean validateChecksums)	Creates a FastLZ decoder with calculation of checksums as specified.
FastLzFrameDecoder(Checksum checksum)	Creates a FastLZ decoder with specified checksum calculator.

Method Summary

Modifier and Type	Method	Description
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Decode the from one ByteBuf to an other.

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded

Field Details

currentState

private FastLzFrameDecoder.State currentState

checksum

private final ByteBufChecksum checksum

Underlying checksum calculator in use.

chunkLength

private int chunkLength

Length of current received chunk of data.

originalLength

private int originalLength

Original of current received chunk of data. It is equal to chunkLength for non compressed chunks.

isCompressed

private boolean isCompressed

Indicates is this chunk compressed or not.

hasChecksum

private boolean hasChecksum

Indicates is this chunk has checksum or not.

currentChecksum

private int currentChecksum

Checksum value of current received chunk of data which has checksum.

Constructor Details

FastLzFrameDecoder

public FastLzFrameDecoder()

Creates the fastest FastLZ decoder without checksum calculation.

FastLzFrameDecoder

public FastLzFrameDecoder(boolean validateChecksums)

Creates a FastLZ decoder with calculation of checksums as specified.

Parameters:

validateChecksums - If true, the checksum field will be validated against the actual uncompressed data, and if the checksums do not match, a suitable DecompressionException will be thrown. Note, that in this case decoder will use Adler32 as a default checksum calculator.

FastLzFrameDecoder

public FastLzFrameDecoder(Checksum checksum)

Creates a FastLZ decoder with specified checksum calculator.

Parameters:

checksum - the Checksum instance to use to check data for integrity. You may set null if you do not want to validate checksum of each block.

Method Details

decode

protected void decode(ChannelHandlerContext ctx,
 ByteBuf in,
 List<Object> out)
               throws Exception

Description copied from class: ByteToMessageDecoder

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read when return from this method or till nothing was read from the input ByteBuf.

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error occurs