Class ZstdEncoder

Nested Class Summary

Constructor Summary

Method Summary

Constructor Details

• 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.

  Parameters:

  compressionLevel - specifies the level of the compression

• ZstdEncoder

  public ZstdEncoder(int blockSize, int maxEncodeSize)

  Creates a new Zstd encoder.

  Parameters:

  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)

  Parameters:

  compressionLevel - specifies the level of the compression

  blockSize - is used to calculate the compressionLevel

  maxEncodeSize - specifies the size of the largest compressed object

Method Details

• allocateBuffer

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

  Description copied from class: MessageToByteEncoder

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

  Overrides:

  allocateBuffer in class MessageToByteEncoder<ByteBuf>

• encode

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

  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

• flush

  public void flush(ChannelHandlerContext ctx)

  Description copied from class: ChannelOutboundHandlerAdapter

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

  Specified by:

  flush in interface ChannelOutboundHandler

  Overrides:

  flush in class ChannelOutboundHandlerAdapter

  Parameters:

  ctx - the ChannelHandlerContext for which the flush operation is made

• handlerAdded

  public void handlerAdded(ChannelHandlerContext ctx)

  Description copied from class: ChannelHandlerAdapter

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

  Specified by:

  handlerAdded in interface ChannelHandler

  Overrides:

  handlerAdded in class ChannelHandlerAdapter

• handlerRemoved

  public void handlerRemoved(ChannelHandlerContext ctx) throws Exception

  Description copied from class: ChannelHandlerAdapter

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

  Specified by:

  handlerRemoved in interface ChannelHandler

  Overrides:

  handlerRemoved in class ChannelHandlerAdapter

  Throws:

  Exception