io.netty.handler.codec.compression

Class Bzip2Encoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

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

io.netty.handler.codec.compression.Bzip2Encoder

All Implemented Interfaces:

ChannelHandler

public class Bzip2Encoder
extends MessageToByteEncoder<ByteBuf>

Compresses a ByteBuf using the Bzip2 algorithm. See Bzip2.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable, ChannelHandler.Skip

Constructor Summary

Constructors

Constructor and Description
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.

Method Summary

Methods

Modifier and Type	Method and Description
ChannelFuture	close() Close this Bzip2Encoder and so finish the encoding.
void	close(ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelHandler 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.

Methods inherited from class io.netty.handler.codec.MessageToByteEncoder

acceptOutboundMessage, allocateBuffer, write

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, connect, deregister, disconnect, exceptionCaught, flush, handlerRemoved, isSharable, read, userEventTriggered

Methods inherited from class java.lang.Object

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

Constructor Detail

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.

Parameters:

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.

Method Detail

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 accour

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 Exception

Description copied from class: ChannelHandlerAdapter

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

Specified by:

close in interface ChannelHandler

Overrides:

close in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws Exception

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

Throws:

Exception