public class JdkZlibEncoder extends ZlibEncoder
ByteBuf
using the deflate algorithm.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. |
Modifier and Type | Method and Description |
---|---|
protected io.netty.buffer.ByteBuf |
allocateBuffer(io.netty.channel.ChannelHandlerContext ctx,
io.netty.buffer.ByteBuf msg,
boolean preferDirect)
Allocate a
ByteBuf which will be used as argument of #encode(ChannelHandlerContext, I, ByteBuf) . |
io.netty.channel.ChannelFuture |
close()
Close this
ZlibEncoder and so finish the encoding. |
void |
close(io.netty.channel.ChannelHandlerContext ctx,
io.netty.channel.ChannelPromise promise) |
io.netty.channel.ChannelFuture |
close(io.netty.channel.ChannelPromise promise)
Close this
ZlibEncoder and so finish the encoding. |
protected void |
encode(io.netty.channel.ChannelHandlerContext ctx,
io.netty.buffer.ByteBuf uncompressed,
io.netty.buffer.ByteBuf out)
Encode a message into a
ByteBuf . |
void |
handlerAdded(io.netty.channel.ChannelHandlerContext ctx) |
boolean |
isClosed()
Returns
true if and only if the end of the compressed stream
has been reached. |
acceptOutboundMessage, isPreferDirect, write
bind, connect, deregister, disconnect, flush, read
ensureNotSharable, exceptionCaught, handlerRemoved, isSharable
public JdkZlibEncoder()
6
)
and the default wrapper (ZlibWrapper.ZLIB
).CompressionException
- if failed to initialize zlibpublic JdkZlibEncoder(int compressionLevel)
compressionLevel
and the default wrapper (ZlibWrapper.ZLIB
).compressionLevel
- 1
yields the fastest compression and 9
yields the
best compression. 0
means no compression. The default
compression level is 6
.CompressionException
- if failed to initialize zlibpublic JdkZlibEncoder(ZlibWrapper wrapper)
6
)
and the specified wrapper.CompressionException
- if failed to initialize zlibpublic JdkZlibEncoder(ZlibWrapper wrapper, int compressionLevel)
compressionLevel
and the specified wrapper.compressionLevel
- 1
yields the fastest compression and 9
yields the
best compression. 0
means no compression. The default
compression level is 6
.CompressionException
- if failed to initialize zlibpublic JdkZlibEncoder(byte[] dictionary)
6
)
and the specified preset dictionary. The wrapper is always
ZlibWrapper.ZLIB
because it is the only format that supports
the preset dictionary.dictionary
- the preset dictionaryCompressionException
- if failed to initialize zlibpublic JdkZlibEncoder(int compressionLevel, byte[] dictionary)
compressionLevel
and the specified preset dictionary. The wrapper is always
ZlibWrapper.ZLIB
because it is the only format that supports
the preset dictionary.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 dictionaryCompressionException
- if failed to initialize zlibpublic io.netty.channel.ChannelFuture close()
ZlibEncoder
ZlibEncoder
and so finish the encoding.
The returned ChannelFuture
will be notified once the
operation completes.close
in class ZlibEncoder
public io.netty.channel.ChannelFuture close(io.netty.channel.ChannelPromise promise)
ZlibEncoder
ZlibEncoder
and so finish the encoding.
The given ChannelFuture
will be notified once the operation
completes and will also be returned.close
in class ZlibEncoder
public boolean isClosed()
ZlibEncoder
true
if and only if the end of the compressed stream
has been reached.isClosed
in class ZlibEncoder
protected void encode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf uncompressed, io.netty.buffer.ByteBuf out) throws Exception
MessageToByteEncoder
ByteBuf
. This method will be called for each written message that can be handled
by this encoder.encode
in class MessageToByteEncoder<io.netty.buffer.ByteBuf>
ctx
- the ChannelHandlerContext
which this MessageToByteEncoder
belongs touncompressed
- the message to encodeout
- the ByteBuf
into which the encoded message will be writtenException
- is thrown if an error occursprotected final io.netty.buffer.ByteBuf allocateBuffer(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf msg, boolean preferDirect) throws Exception
MessageToByteEncoder
ByteBuf
which will be used as argument of #encode(ChannelHandlerContext, I, ByteBuf)
.
Sub-classes may override this method to return ByteBuf
with a perfect matching initialCapacity
.allocateBuffer
in class MessageToByteEncoder<io.netty.buffer.ByteBuf>
Exception
public void close(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise) throws Exception
close
in interface io.netty.channel.ChannelOutboundHandler
close
in class io.netty.channel.ChannelOutboundHandlerAdapter
Exception
Copyright © 2008–2019 The Netty Project. All rights reserved.