io.netty.handler.codec.compression

类 ZstdEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

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

io.netty.handler.codec.compression.ZstdEncoder

所有已实现的接口:

ChannelHandler, ChannelOutboundHandler

public final class ZstdEncoder
extends MessageToByteEncoder<ByteBuf>

Compresses a ByteBuf using the Zstandard algorithm. See Zstandard.

嵌套类概要

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

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
ZstdEncoder() Creates a new Zstd encoder.
ZstdEncoder(int compressionLevel) Creates a new Zstd encoder.
ZstdEncoder(int blockSize, int maxEncodeSize) Creates a new Zstd encoder.
ZstdEncoder(int compressionLevel, int blockSize, int maxEncodeSize)

方法概要

限定符和类型	方法和说明
protected ByteBuf	allocateBuffer(ChannelHandlerContext ctx, ByteBuf msg, boolean preferDirect) Allocate a ByteBuf which will be used as argument of #encode(ChannelHandlerContext, I, ByteBuf).
protected void	encode(ChannelHandlerContext ctx, ByteBuf in, ByteBuf out) Encode a message into a ByteBuf.
void	flush(ChannelHandlerContext ctx) Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
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.

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

acceptOutboundMessage, isPreferDirect, write

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

bind, close, connect, deregister, disconnect, read

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

ensureNotSharable, exceptionCaught, isSharable

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

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

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

exceptionCaught

构造器详细资料

ZstdEncoder

public ZstdEncoder()

Creates a new Zstd encoder. Please note that if you use the default constructor, the default BLOCK_SIZE and MAX_BLOCK_SIZE will be used. If you want to specify BLOCK_SIZE and MAX_BLOCK_SIZE yourself, please use ZstdEncoder(int,int) constructor

ZstdEncoder

public ZstdEncoder(int compressionLevel)

Creates a new Zstd encoder.

参数:

compressionLevel - specifies the level of the compression

ZstdEncoder

public ZstdEncoder(int blockSize,
                   int maxEncodeSize)

Creates a new Zstd encoder.

参数:

blockSize - is used to calculate the compressionLevel

maxEncodeSize - specifies the size of the largest compressed object

ZstdEncoder

public ZstdEncoder(int compressionLevel,
                   int blockSize,
                   int maxEncodeSize)

参数:

blockSize - is used to calculate the compressionLevel

maxEncodeSize - specifies the size of the largest compressed object

compressionLevel - specifies the level of the compression

方法详细资料

allocateBuffer

protected ByteBuf allocateBuffer(ChannelHandlerContext ctx,
                                 ByteBuf msg,
                                 boolean preferDirect)

从类复制的说明: MessageToByteEncoder

Allocate a ByteBuf which will be used as argument of #encode(ChannelHandlerContext, I, ByteBuf). Sub-classes may override this method to return ByteBuf with a perfect matching initialCapacity.

覆盖:

allocateBuffer 在类中 MessageToByteEncoder<ByteBuf>

encode

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

从类复制的说明: 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

flush

public void flush(ChannelHandlerContext ctx)

从类复制的说明: ChannelOutboundHandlerAdapter

Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

flush 在接口中 ChannelOutboundHandler

覆盖:

flush 在类中 ChannelOutboundHandlerAdapter

参数:

ctx - the ChannelHandlerContext for which the flush operation is made

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)

从类复制的说明: ChannelHandlerAdapter

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

指定者:

handlerAdded 在接口中 ChannelHandler

覆盖:

handlerAdded 在类中 ChannelHandlerAdapter

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