JdkZlibEncoder (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelOutboundHandlerAdapter
  - - io.netty.handler.codec.MessageToByteEncoder<ByteBuf>
    - - io.netty.handler.codec.compression.ZlibEncoder
      - io.netty.handler.codec.compression.JdkZlibEncoder

所有已实现的接口:

ChannelHandler, ChannelOutboundHandler
```
public class JdkZlibEncoder
extends ZlibEncoder
```
Compresses a ByteBuf using the deflate algorithm.

嵌套类概要
- 从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

构造器概要

构造器
构造器和说明
`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.

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`protected ByteBuf`	`allocateBuffer(ChannelHandlerContext ctx, ByteBuf msg, boolean preferDirect)` Allocate a `ByteBuf` which will be used as argument of `#encode(ChannelHandlerContext, I, ByteBuf)`.
`ChannelFuture`	`close()` Close this `ZlibEncoder` 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 `ZlibEncoder` and so finish the encoding.
`protected void`	`encode(ChannelHandlerContext ctx, ByteBuf uncompressed, 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, 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

- 构造器详细资料
  - JdkZlibEncoder
```
public JdkZlibEncoder()
```
    Creates a new zlib encoder with the default compression level (6) and the default wrapper (ZlibWrapper.ZLIB).
    
    抛出:
    
    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).
    
    参数:
    
    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 zlib
  - JdkZlibEncoder
```
public JdkZlibEncoder(ZlibWrapper wrapper)
```
    Creates a new zlib encoder with the default compression level (6) and the specified wrapper.
    
    抛出:
    
    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.
    
    参数:
    
    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 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.
    
    参数:
    
    dictionary - the preset dictionary
    
    抛出:
    
    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.
    
    参数:
    
    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
    
    抛出:
    
    CompressionException - if failed to initialize zlib
- 方法详细资料
  - close
```
public ChannelFuture close()
```
    从类复制的说明: ZlibEncoder
    
    Close this ZlibEncoder and so finish the encoding. The returned ChannelFuture will be notified once the operation completes.
    
    指定者:
    
    close 在类中 ZlibEncoder
  - close
```
public ChannelFuture close(ChannelPromise promise)
```
    从类复制的说明: ZlibEncoder
    
    Close this ZlibEncoder and so finish the encoding. The given ChannelFuture will be notified once the operation completes and will also be returned.
    
    指定者:
    
    close 在类中 ZlibEncoder
  - isClosed
```
public boolean isClosed()
```
    从类复制的说明: ZlibEncoder
    
    Returns true if and only if the end of the compressed stream has been reached.
    
    指定者:
    
    isClosed 在类中 ZlibEncoder
  - encode
```
protected void encode(ChannelHandlerContext ctx,
                      ByteBuf uncompressed,
                      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
    
    uncompressed - the message to encode
    
    out - the ByteBuf into which the encoded message will be written
    
    抛出:
    
    java.lang.Exception - is thrown if an error occurs
  - allocateBuffer
```
protected final ByteBuf allocateBuffer(ChannelHandlerContext ctx,
                                       ByteBuf msg,
                                       boolean preferDirect)
                                throws java.lang.Exception
```
    从类复制的说明: MessageToByteEncoder
    
    Allocate a 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 在类中 MessageToByteEncoder<ByteBuf>
    
    抛出:
    
    java.lang.Exception
  - 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

类 JdkZlibEncoder

嵌套类概要

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

构造器概要

方法概要

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

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

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

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

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

构造器详细资料

JdkZlibEncoder

JdkZlibEncoder

JdkZlibEncoder

JdkZlibEncoder

JdkZlibEncoder

JdkZlibEncoder

方法详细资料

close

close

isClosed

encode

allocateBuffer

close

handlerAdded