io.netty.handler.codec.compression

类 Bzip2Encoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

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

io.netty.handler.codec.compression.Bzip2Encoder

所有已实现的接口:

ChannelHandler, ChannelOutboundHandler

public class Bzip2Encoder
extends MessageToByteEncoder<ByteBuf>

Compresses a ByteBuf using the Bzip2 algorithm. See Bzip2.

嵌套类概要

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

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
Bzip2Encoder() Creates a new bzip2 encoder with the maximum (900,000 byte) block size.
Bzip2Encoder(int blockSizeMultiplier) Creates a new bzip2 encoder with the specified blockSizeMultiplier.

方法概要

限定符和类型	方法和说明
ChannelFuture	close() Close this Bzip2Encoder and so finish the encoding.
void	close(ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelOutboundInvoker.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
ChannelFuture	close(ChannelPromise promise) Close this Bzip2Encoder and so finish the encoding.
protected void	encode(ChannelHandlerContext ctx, ByteBuf in, ByteBuf out) Encode a message into a ByteBuf.
void	handlerAdded(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
boolean	isClosed() Returns true if and only if the end of the compressed stream has been reached.

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

acceptOutboundMessage, allocateBuffer, isPreferDirect, write

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

bind, connect, deregister, disconnect, flush, read

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

ensureNotSharable, exceptionCaught, handlerRemoved, isSharable

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

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

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

exceptionCaught, handlerRemoved

构造器详细资料

Bzip2Encoder

public Bzip2Encoder()

Creates a new bzip2 encoder with the maximum (900,000 byte) block size.

Bzip2Encoder

public Bzip2Encoder(int blockSizeMultiplier)

Creates a new bzip2 encoder with the specified blockSizeMultiplier.

参数:

blockSizeMultiplier - The Bzip2 block size as a multiple of 100,000 bytes (minimum 1, maximum 9). Larger block sizes require more memory for both compression and decompression, but give better compression ratios. 9 will usually be the best value to use.

方法详细资料

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

isClosed

public boolean isClosed()

Returns true if and only if the end of the compressed stream has been reached.

close

public ChannelFuture close()

Close this Bzip2Encoder and so finish the encoding. The returned ChannelFuture will be notified once the operation completes.

close

public ChannelFuture close(ChannelPromise promise)

Close this Bzip2Encoder and so finish the encoding. The given ChannelFuture will be notified once the operation completes and will also be returned.

close

public void close(ChannelHandlerContext ctx,
                  ChannelPromise promise)
           throws java.lang.Exception

从类复制的说明: ChannelOutboundHandlerAdapter

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

指定者:

close 在接口中 ChannelOutboundHandler

覆盖:

close 在类中 ChannelOutboundHandlerAdapter

参数:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

handlerAdded

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

从类复制的说明: ChannelHandlerAdapter

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

指定者:

handlerAdded 在接口中 ChannelHandler

覆盖:

handlerAdded 在类中 ChannelHandlerAdapter

抛出:

java.lang.Exception