Modifier and Type	Class and Description
private static enum	Bzip2Encoder.State Current state of stream.

Field Summary

Modifier and Type	Field and Description
private Bzip2BlockCompressor	blockCompressor The compressor for the current block.
private volatile ChannelHandlerContext	ctx Used to interact with its `ChannelPipeline` and other handlers.
private Bzip2Encoder.State	currentState
private volatile boolean	finished (@code true} if the compressed stream has been finished, otherwise `false`.
private final int	streamBlockSize The declared maximum block size of the stream (before final run-length decoding).
private int	streamCRC The merged CRC of all blocks compressed so far.
private final Bzip2BitWriter	writer A writer that provides bit-level writes.

Constructor Summary

Access	Constructor and Description
public	Bzip2Encoder() Creates a new bzip2 encoder with the maximum (900,000 byte) block size.
public	Bzip2Encoder(final int 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. blockSizeMultiplier) Creates a new bzip2 encoder with the specified `blockSizeMultiplier`.

Method Summary

Modifier and Type	Method and Description
public ChannelFuture	close() Close this `Bzip2Encoder` and so finish the encoding.
public ChannelFuture	close(final ChannelPromise promise) Close this `Bzip2Encoder` and so finish the encoding.
public void	close(final ChannelHandlerContext the `ChannelHandlerContext` for which the close operation is made ctx, final ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Overrides io.netty.channel.ChannelOutboundHandlerAdapter.close. Implements io.netty.channel.ChannelOutboundHandler.close. Calls `ChannelHandlerContext#close(ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`.
private void	closeBlock(ByteBuf out) Close current block and update `streamCRC`.
private ChannelHandlerContext	ctx()
protected void	encode(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToByteEncoder` belongs to ctx, ByteBuf the message to encode in, ByteBuf the `ByteBuf` into which the encoded message will be written out) Implements abstract io.netty.handler.codec.MessageToByteEncoder.encode. Encode a message into a `ByteBuf`.
private ChannelFuture	finishEncode(final ChannelHandlerContext ctx, ChannelPromise promise)
public void	handlerAdded(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events.
public boolean	isClosed() Returns `true` if and only if the end of the compressed stream has been reached.

Inherited from io.netty.handler.codec.MessageToByteEncoder:: acceptOutboundMessage allocateBuffer isPreferDirect write

Field Detail

blockCompressor	back to summary
private Bzip2BlockCompressor blockCompressor The compressor for the current block.

ctx	back to summary
private volatile ChannelHandlerContext ctx Used to interact with its `ChannelPipeline` and other handlers.

currentState	back to summary
private Bzip2Encoder.State currentState

finished	back to summary
private volatile boolean finished (@code true} if the compressed stream has been finished, otherwise `false`.

streamBlockSize	back to summary
private final int streamBlockSize The declared maximum block size of the stream (before final run-length decoding).

streamCRC	back to summary
private int streamCRC The merged CRC of all blocks compressed so far.

writer	back to summary
private final Bzip2BitWriter writer A writer that provides bit-level writes.

Constructor Detail

Bzip2Encoder	back to summary
public Bzip2Encoder() Creates a new bzip2 encoder with the maximum (900,000 byte) block size.

Bzip2Encoder back to summary

Bzip2Encoder	back to summary
public Bzip2Encoder(final int blockSizeMultiplier) Creates a new bzip2 encoder with the specified `blockSizeMultiplier`. Parameters blockSizeMultiplier:int 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.

public Bzip2Encoder(final int blockSizeMultiplier)

Creates a new bzip2 encoder with the specified blockSizeMultiplier.

Parameters

blockSizeMultiplier:int: 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

close	back to summary
public ChannelFuture close() Close this `Bzip2Encoder` and so finish the encoding. The returned `ChannelFuture` will be notified once the operation completes.

close	back to summary
public ChannelFuture close(final 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 back to summary

close	back to summary
public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) throws Exception Overrides io.netty.channel.ChannelOutboundHandlerAdapter.close. Implements io.netty.channel.ChannelOutboundHandler.close. Doc from io.netty.channel.ChannelOutboundHandlerAdapter.close. Calls `ChannelHandlerContext#close(ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`. Sub-classes may override this method to change behavior. Parameters ctx:ChannelHandlerContext Doc from io.netty.channel.ChannelOutboundHandler.close. the `ChannelHandlerContext` for which the close operation is made promise:ChannelPromise Doc from io.netty.channel.ChannelOutboundHandler.close. the `ChannelPromise` to notify once the operation completes Annotations @Override Exceptions Exception: Doc from io.netty.channel.ChannelOutboundHandler.close. thrown if an error occurs

public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) throws Exception

Overrides io.netty.channel.ChannelOutboundHandlerAdapter.close.

Implements io.netty.channel.ChannelOutboundHandler.close.

Doc from io.netty.channel.ChannelOutboundHandlerAdapter.close.

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

Parameters

ctx:ChannelHandlerContext

Doc from io.netty.channel.ChannelOutboundHandler.close.

the ChannelHandlerContext for which the close operation is made

promise:ChannelPromise

Doc from io.netty.channel.ChannelOutboundHandler.close.

the ChannelPromise to notify once the operation completes

Annotations

@Override

Exceptions

Exception:

Doc from io.netty.channel.ChannelOutboundHandler.close.

thrown if an error occurs

closeBlock	back to summary
private void closeBlock(ByteBuf out) Close current block and update `streamCRC`.

ctx	back to summary
private ChannelHandlerContext ctx()

encode back to summary

encode	back to summary
protected void encode(ChannelHandlerContext ctx, ByteBuf in, ByteBuf out) throws Exception Implements abstract io.netty.handler.codec.MessageToByteEncoder.encode. Doc from io.netty.handler.codec.MessageToByteEncoder.encode. Encode a message into a `ByteBuf`. This method will be called for each written message that can be handled by this encoder. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToByteEncoder` belongs to in:ByteBuf the message to encode out:ByteBuf the `ByteBuf` into which the encoded message will be written Annotations @Override Exceptions Exception: is thrown if an error occurs

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

Implements abstract io.netty.handler.codec.MessageToByteEncoder.encode.

Doc from io.netty.handler.codec.MessageToByteEncoder.encode.

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

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToByteEncoder belongs to
in:ByteBuf: the message to encode
out:ByteBuf: the ByteBuf into which the encoded message will be written

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

finishEncode	back to summary
private ChannelFuture finishEncode(final ChannelHandlerContext ctx, ChannelPromise promise)

handlerAdded back to summary

handlerAdded	back to summary
public void handlerAdded(ChannelHandlerContext ctx) throws Exception Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Doc from io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events. Annotations @Override

public void handlerAdded(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded.

Implements io.netty.channel.ChannelHandler.handlerAdded.

Doc from io.netty.channel.ChannelHandler.handlerAdded.

Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.

Annotations

@Override

isClosed	back to summary
public boolean isClosed() Returns `true` if and only if the end of the compressed stream has been reached.

io.netty.handler.codec.compression back to summary

private final Enum Bzip2Encoder.State

Class Inheritance

extends Enum<Bzip2Encoder.State>

java.lang.Object
java.lang.Enum
io.netty.handler.codec.compression.Bzip2Encoder.State

Current state of stream.

Field Summary

Modifier and Type	Field and Description
public static final Bzip2Encoder.State	CLOSE_BLOCK
public static final Bzip2Encoder.State	INIT
public static final Bzip2Encoder.State	INIT_BLOCK
public static final Bzip2Encoder.State	WRITE_DATA

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static Bzip2Encoder.State	valueOf(String name)
public static Bzip2Encoder.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CLOSE_BLOCK	back to summary
public static final Bzip2Encoder.State CLOSE_BLOCK

INIT	back to summary
public static final Bzip2Encoder.State INIT

INIT_BLOCK	back to summary
public static final Bzip2Encoder.State INIT_BLOCK

WRITE_DATA	back to summary
public static final Bzip2Encoder.State WRITE_DATA

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static Bzip2Encoder.State valueOf(String name)

values	back to summary
public static Bzip2Encoder.State[] values()

public Class Bzip2Encoder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum Bzip2Encoder.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail