io.netty.handler.codec.compression

Class JdkZlibEncoder

java.lang.Object

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.channel.ChannelOutboundByteHandlerAdapter

io.netty.handler.codec.ByteToByteEncoder

io.netty.handler.codec.compression.ZlibEncoder

io.netty.handler.codec.compression.JdkZlibEncoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundByteHandler, io.netty.channel.ChannelOutboundHandler

public class JdkZlibEncoder
extends ZlibEncoder

Compresses a ByteBuf using the deflate algorithm.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
JdkZlibEncoder() Creates a new zlib encoder with the default compression level (6) and the default wrapper (ZlibWrapper.ZLIB).
JdkZlibEncoder(byte[] dictionary) Creates a new zlib encoder with the default compression level (6) and the specified preset dictionary.
JdkZlibEncoder(int compressionLevel) Creates a new zlib encoder with the specified compressionLevel and the default wrapper (ZlibWrapper.ZLIB).
JdkZlibEncoder(int compressionLevel, byte[] dictionary) Creates a new zlib encoder with the specified compressionLevel and the specified preset dictionary.
JdkZlibEncoder(ZlibWrapper wrapper) Creates a new zlib encoder with the default compression level (6) and the specified wrapper.
JdkZlibEncoder(ZlibWrapper wrapper, int compressionLevel) Creates a new zlib encoder with the specified compressionLevel and the specified wrapper.

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeAdd(io.netty.channel.ChannelHandlerContext ctx)
io.netty.channel.ChannelFuture	close()
io.netty.channel.ChannelFuture	close(io.netty.channel.ChannelFuture future)
void	close(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelFuture future)
void	encode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, io.netty.buffer.ByteBuf out)
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.ByteToByteEncoder

flush

Methods inherited from class io.netty.channel.ChannelOutboundByteHandlerAdapter

newOutboundBuffer

Methods inherited from class io.netty.channel.ChannelOperationHandlerAdapter

afterAdd, afterRemove, beforeRemove, bind, connect, deregister, disconnect, exceptionCaught, userEventTriggered

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelOperationHandler

bind, connect, deregister, disconnect

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

JdkZlibEncoder

public JdkZlibEncoder()

Creates a new zlib encoder with the default compression level (6) and the default wrapper (ZlibWrapper.ZLIB).

Throws:

CompressionException - if failed to initialize zlib

JdkZlibEncoder

public JdkZlibEncoder(int compressionLevel)

Creates a new zlib encoder with the specified compressionLevel and the default wrapper (ZlibWrapper.ZLIB).

Parameters:

compressionLevel - 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.

Throws:

CompressionException - if failed to initialize zlib

JdkZlibEncoder

public JdkZlibEncoder(ZlibWrapper wrapper)

Creates a new zlib encoder with the default compression level (6) and the specified wrapper.

Throws:

CompressionException - if failed to initialize zlib

JdkZlibEncoder

public JdkZlibEncoder(ZlibWrapper wrapper,
              int compressionLevel)

Creates a new zlib encoder with the specified compressionLevel and the specified wrapper.

Parameters:

compressionLevel - 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.

Throws:

CompressionException - if failed to initialize zlib

JdkZlibEncoder

public JdkZlibEncoder(byte[] dictionary)

Creates a new zlib encoder with the default compression level (6) and the specified preset dictionary. The wrapper is always ZlibWrapper.ZLIB because it is the only format that supports the preset dictionary.

Parameters:

dictionary - the preset dictionary

Throws:

CompressionException - if failed to initialize zlib

JdkZlibEncoder

public JdkZlibEncoder(int compressionLevel,
              byte[] dictionary)

Creates a new zlib encoder with the specified compressionLevel and the specified preset dictionary. The wrapper is always ZlibWrapper.ZLIB because it is the only format that supports the preset dictionary.

Parameters:

compressionLevel - 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.

dictionary - the preset dictionary

Throws:

CompressionException - if failed to initialize zlib

Method Detail

close

public io.netty.channel.ChannelFuture close()

Specified by:

close in class ZlibEncoder

close

public io.netty.channel.ChannelFuture close(io.netty.channel.ChannelFuture future)

Specified by:

close in class ZlibEncoder

isClosed

public boolean isClosed()

Description copied from class: ZlibEncoder

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

Specified by:

isClosed in class ZlibEncoder

encode

public void encode(io.netty.channel.ChannelHandlerContext ctx,
          io.netty.buffer.ByteBuf in,
          io.netty.buffer.ByteBuf out)
            throws Exception

Specified by:

encode in class ByteToByteEncoder

Throws:

Exception

close

public void close(io.netty.channel.ChannelHandlerContext ctx,
         io.netty.channel.ChannelFuture future)
           throws Exception

Specified by:

close in interface io.netty.channel.ChannelOperationHandler

Overrides:

close in class io.netty.channel.ChannelOperationHandlerAdapter

Throws:

Exception

beforeAdd

public void beforeAdd(io.netty.channel.ChannelHandlerContext ctx)
               throws Exception

Specified by:

beforeAdd in interface io.netty.channel.ChannelHandler

Overrides:

beforeAdd in class io.netty.channel.ChannelOperationHandlerAdapter

Throws:

Exception