io.netty.handler.codec.compression

类 LzfEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

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

io.netty.handler.codec.compression.LzfEncoder

所有已实现的接口:

ChannelHandler, ChannelOutboundHandler

public class LzfEncoder
extends MessageToByteEncoder<ByteBuf>

Compresses a ByteBuf using the LZF format.

See original LZF package and LZF format for full description.

嵌套类概要

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
LzfEncoder() Creates a new LZF encoder with the most optimal available methods for underlying data access.
LzfEncoder(boolean safeInstance) Creates a new LZF encoder with specified encoding instance.
LzfEncoder(boolean safeInstance, int totalLength) Creates a new LZF encoder with specified encoding instance and compressThreshold.
LzfEncoder(boolean safeInstance, int totalLength, int compressThreshold) Creates a new LZF encoder with specified settings.
LzfEncoder(int totalLength) Creates a new LZF encoder with specified total length of encoded chunk.

方法概要

限定符和类型	方法和说明
protected void	encode(ChannelHandlerContext ctx, ByteBuf in, ByteBuf out) Encode a message into a ByteBuf.
void	handlerRemoved(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.

从类继承的方法 io.netty.handler.codec.MessageToByteEncoder

acceptOutboundMessage, allocateBuffer, isPreferDirect, write

从类继承的方法 io.netty.channel.ChannelOutboundHandlerAdapter

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

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded

构造器详细资料

LzfEncoder

public LzfEncoder()

Creates a new LZF encoder 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 LzfEncoder(boolean) with true param.

LzfEncoder

public LzfEncoder(boolean safeInstance)

Creates a new LZF encoder with specified encoding instance.

参数:

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

LzfEncoder

public LzfEncoder(boolean safeInstance,
                  int totalLength)

Creates a new LZF encoder with specified encoding instance and compressThreshold.

参数:

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

totalLength - Expected total length of content to compress; only matters for outgoing messages that is smaller than maximum chunk size (64k), to optimize encoding hash tables.

LzfEncoder

public LzfEncoder(int totalLength)

Creates a new LZF encoder with specified total length of encoded chunk. You can configure it to encode your data flow more efficient if you know the average size of messages that you send.

参数:

totalLength - Expected total length of content to compress; only matters for outgoing messages that is smaller than maximum chunk size (64k), to optimize encoding hash tables.

LzfEncoder

public LzfEncoder(boolean safeInstance,
                  int totalLength,
                  int compressThreshold)

Creates a new LZF encoder with specified settings.

参数:

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

totalLength - Expected total length of content to compress; only matters for outgoing messages that is smaller than maximum chunk size (64k), to optimize encoding hash tables.

compressThreshold - Compress threshold for LZF format. When the amount of input data is less than compressThreshold, we will construct an uncompressed output according to the LZF format.

方法详细资料

encode

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

从类复制的说明: MessageToByteEncoder

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

指定者:

encode 在类中 MessageToByteEncoder<ByteBuf>

参数:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

in - the message to encode

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

抛出:

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

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception

从类复制的说明: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

指定者:

handlerRemoved 在接口中 ChannelHandler

覆盖:

handlerRemoved 在类中 ChannelHandlerAdapter

抛出:

java.lang.Exception