Class FastLzFrameEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToByteEncoder<ByteBuf>

io.netty.handler.codec.compression.FastLzFrameEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

public class FastLzFrameEncoder
extends MessageToByteEncoder<ByteBuf>

Compresses a ByteBuf using the FastLZ algorithm. See FastLZ format.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Constructor Summary

Constructors

Constructor	Description
FastLzFrameEncoder()	Creates a FastLZ encoder without checksum calculator and with auto detection of compression level.
FastLzFrameEncoder(boolean validateChecksums)	Creates a FastLZ encoder with auto detection of compression level and calculation of checksums as specified.
FastLzFrameEncoder(int level)	Creates a FastLZ encoder with specified compression level and without checksum calculator.
FastLzFrameEncoder(int level, Checksum checksum)	Creates a FastLZ encoder with specified compression level and checksum calculator.

Method Summary

Modifier and Type	Method	Description
protected void	encode(ChannelHandlerContext ctx, ByteBuf in, ByteBuf out)	Encode a message into a ByteBuf.

Methods inherited from class MessageToByteEncoder

acceptOutboundMessage, allocateBuffer, isPreferDirect, write

Modifier and Type	Method	Description
boolean	acceptOutboundMessage(Object msg)	Returns true if the given message should be handled.
protected ByteBuf	allocateBuffer(ChannelHandlerContext ctx, ByteBuf msg, boolean preferDirect)	Allocate a ByteBuf which will be used as argument of MessageToByteEncoder.encode(ChannelHandlerContext, I, ByteBuf).
protected boolean	isPreferDirect()
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)	Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.deregister(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	flush(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	read(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Deprecated. is part of ChannelInboundHandler
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Methods inherited from class Object

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

Constructor Details

FastLzFrameEncoder

public FastLzFrameEncoder()

Creates a FastLZ encoder without checksum calculator and with auto detection of compression level.

FastLzFrameEncoder

public FastLzFrameEncoder(int level)

Creates a FastLZ encoder with specified compression level and without checksum calculator.

Parameters:

level - supports only these values: 0 - Encoder will choose level automatically depending on the length of the input buffer. 1 - Level 1 is the fastest compression and generally useful for short data. 2 - Level 2 is slightly slower but it gives better compression ratio.

FastLzFrameEncoder

public FastLzFrameEncoder(boolean validateChecksums)

Creates a FastLZ encoder with auto detection of compression level and calculation of checksums as specified.

Parameters:

validateChecksums - If true, the checksum of each block will be calculated and this value will be added to the header of block. By default FastLzFrameEncoder uses Adler32 for checksum calculation.

FastLzFrameEncoder

public FastLzFrameEncoder(int level,
 Checksum checksum)

Creates a FastLZ encoder with specified compression level and checksum calculator.

Parameters:

level - supports only these values: 0 - Encoder will choose level automatically depending on the length of the input buffer. 1 - Level 1 is the fastest compression and generally useful for short data. 2 - Level 2 is slightly slower but it gives better compression ratio.

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

Method Details

encode

protected void encode(ChannelHandlerContext ctx,
 ByteBuf in,
 ByteBuf out)
               throws Exception

Description copied from class: MessageToByteEncoder

Encode a message into a ByteBuf. This method will be called for each written message that can be handled by this encoder.

Specified by:

encode in class MessageToByteEncoder<ByteBuf>

Parameters:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

in - the message to encode

out - the ByteBuf into which the encoded message will be written

Throws:

Exception - is thrown if an error occurs