io.netty.handler.codec.compression

Class LzfDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.compression.LzfDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class LzfDecoder
extends ByteToMessageDecoder

Uncompresses a ByteBuf encoded with the LZF format. See original LZF package and LZF format for full description.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	LzfDecoder.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 and Description
private int	chunkLength Length of current received chunk of data.
private LzfDecoder.State	currentState
private com.ning.compress.lzf.ChunkDecoder	decoder Underlying decoder in use.
private boolean	isCompressed Indicates is this chunk compressed or not.
private static short	MAGIC_NUMBER Magic number of LZF chunk.
private int	originalLength Original length of current received chunk of data.
private com.ning.compress.BufferRecycler	recycler Object that handles details of buffer recycling.

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

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor and Description
LzfDecoder() Creates a new LZF decoder with the most optimal available methods for underlying data access.
LzfDecoder(boolean safeInstance) Creates a new LZF decoder with specified decoding instance.

Method Summary

Modifier and Type	Method and Description
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.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 Detail

currentState

private LzfDecoder.State currentState

MAGIC_NUMBER

private static final short MAGIC_NUMBER

Magic number of LZF chunk.

See Also:

Constant Field Values

decoder

private com.ning.compress.lzf.ChunkDecoder decoder

Underlying decoder in use.

recycler

private com.ning.compress.BufferRecycler recycler

Object that handles details of buffer recycling.

chunkLength

private int chunkLength

Length of current received chunk of data.

originalLength

private int originalLength

Original length 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.

Constructor Detail

LzfDecoder

public LzfDecoder()

Creates a new LZF decoder with the most optimal available methods for underlying data access. It will "unsafe" instance if one can be used on current JVM. It should be safe to call this constructor as implementations are dynamically loaded; however, on some non-standard platforms it may be necessary to use LzfDecoder(boolean) with true param.

LzfDecoder

public LzfDecoder(boolean safeInstance)

Creates a new LZF decoder with specified decoding instance.

Parameters:

safeInstance - If true decoder will use ChunkDecoder that only uses standard JDK access methods, and should work on all Java platforms and JVMs. Otherwise decoder will try to use highly optimized ChunkDecoder implementation that uses Sun JDK's Unsafe class (which may be included by other JDK's as well).

Method Detail

decode

protected void decode(ChannelHandlerContext ctx,
                      ByteBuf in,
                      java.util.List<java.lang.Object> out)
               throws java.lang.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:

java.lang.Exception - is thrown if an error occurs