JdkZlibEncoder (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

ChannelHandler ， ChannelOutboundHandler
```
public class JdkZlibEncoder
extends ZlibEncoder
```
使用deflate算法压缩ByteBuf 。

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

构造方法摘要

构造方法
Constructor and Description
`JdkZlibEncoder()` 使用默认压缩级别（ `6` ）和默认包装器（ `ZlibWrapper.ZLIB` ）创建新的zlib编码器。
`JdkZlibEncoder(byte[] dictionary)` 使用默认压缩级别（ `6` ）和指定的预设词典创建新的zlib编码器。
`JdkZlibEncoder(int compressionLevel)` 用指定的 `compressionLevel`和默认包装器（ `ZlibWrapper.ZLIB` ）创建一个新的zlib编码器。
`JdkZlibEncoder(int compressionLevel, byte[] dictionary)` 用指定的 `compressionLevel`和指定的预置字典创建一个新的zlib编码器。
`JdkZlibEncoder(ZlibWrapper wrapper)` 用默认压缩级别（ `6` ）和指定的包装器创建一个新的zlib编码器。
`JdkZlibEncoder(ZlibWrapper wrapper, int compressionLevel)` 用指定的 `compressionLevel`和指定的包装器创建一个新的zlib编码器。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`protected ByteBuf`	`allocateBuffer(ChannelHandlerContext ctx, ByteBuf msg, boolean preferDirect)` 分配一个`ByteBuf` ，它将用作`#encode(ChannelHandlerContext, I, ByteBuf)`参数。
`ChannelFuture`	`close()` 关闭此`ZlibEncoder`并完成编码。
`void`	`close(ChannelHandlerContext ctx, ChannelPromise promise)` 致电`ChannelOutboundInvoker.close(ChannelPromise)`转发至`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`ChannelFuture`	`close(ChannelPromise promise)` 关闭此`ZlibEncoder`并完成编码。
`protected void`	`encode(ChannelHandlerContext ctx, ByteBuf uncompressed, ByteBuf out)` 将消息编码成`ByteBuf` 。
`void`	`handlerAdded(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`boolean`	`isClosed()` 当且仅当已达到压缩流的结束时才返回 `true` 。

Methods inherited from class io.netty.handler.codec.MessageToByteEncoder
acceptOutboundMessage, isPreferDirect, write

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter
bind, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, exceptionCaught, handlerRemoved, isSharable

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.ChannelHandler
exceptionCaught, handlerRemoved

- 构造方法详细信息
  - JdkZlibEncoder
```
public JdkZlibEncoder()
```
    使用默认压缩级别（ 6 ）和默认包装器（ ZlibWrapper.ZLIB ）创建新的zlib编码器。
    
    异常
    
    CompressionException - 如果初始化zlib失败
  - JdkZlibEncoder
```
public JdkZlibEncoder(int compressionLevel)
```
    用指定的 compressionLevel和默认包装器（ ZlibWrapper.ZLIB ）创建一个新的zlib编码器。
    
    参数
    
    compressionLevel - 1产生最快的压缩率， 9产生最好的压缩率。 0意味着没有压缩。默认的压缩级别是6 。
    
    异常
    
    CompressionException - 如果初始化zlib失败
  - JdkZlibEncoder
```
public JdkZlibEncoder(ZlibWrapper wrapper)
```
    用默认的压缩级别（ 6 ）和指定的包装器创建一个新的zlib编码器。
    
    异常
    
    CompressionException - 如果初始化zlib失败
  - JdkZlibEncoder
```
public JdkZlibEncoder(ZlibWrapper wrapper,
                      int compressionLevel)
```
    用指定的 compressionLevel和指定的包装器创建一个新的zlib编码器。
    
    参数
    
    compressionLevel - 1产生最快的压缩率， 9产生最好的压缩率。 0表示不压缩。默认的压缩级别是6 。
    
    异常
    
    CompressionException - 如果初始化zlib失败
  - JdkZlibEncoder
```
public JdkZlibEncoder(byte[] dictionary)
```
    使用默认压缩级别（ 6 ）和指定的预设字典创建新的zlib编码器。包装始终是ZlibWrapper.ZLIB，因为它是支持预设字典的唯一格式。
    
    参数
    
    dictionary - 预设词典
    
    异常
    
    CompressionException - 如果初始化zlib失败
  - JdkZlibEncoder
```
public JdkZlibEncoder(int compressionLevel,
                      byte[] dictionary)
```
    用指定的compressionLevel和指定的预置字典创建一个新的zlib编码器。包装始终是ZlibWrapper.ZLIB，因为它是唯一支持预设字典的格式。
    
    参数
    
    compressionLevel - 1产生最快的压缩率， 9产生最好的压缩率。 0表示没有压缩。默认的压缩级别是6 。
    
    dictionary - 预设词典
    
    异常
    
    CompressionException - 如果初始化zlib失败
- 方法详细信息
  - close
```
public ChannelFuture close()
```
    从类复制的描述： ZlibEncoder
    
    关闭此ZlibEncoder并完成编码。一旦操作完成，返回的ChannelFuture将会收到通知。
    
    Specified by:
    
    close在课堂 ZlibEncoder
  - close
```
public ChannelFuture close(ChannelPromise promise)
```
    从类复制的描述： ZlibEncoder
    
    关闭此ZlibEncoder并完成编码。一旦操作完成，给定的ChannelFuture将被通知，并且也将被返回。
    
    Specified by:
    
    close在课堂 ZlibEncoder
  - isClosed
```
public boolean isClosed()
```
    从类复制的描述： ZlibEncoder
    
    当且仅当已到达压缩流的结尾时才返回 true 。
    
    Specified by:
    
    isClosed在课堂上 ZlibEncoder
  - encode
```
protected void encode(ChannelHandlerContext ctx,
                      ByteBuf uncompressed,
                      ByteBuf out)
               throws java.lang.Exception
```
    从类复制的描述： MessageToByteEncoder
    
    将消息编码成ByteBuf 。这个方法将被编码器处理的每个书面信息调用。
    
    Specified by:
    
    encode在课堂 MessageToByteEncoder<ByteBuf>
    
    参数
    
    ctx - 这MessageToByteEncoder属于的ChannelHandlerContext
    
    uncompressed - 要编码的消息
    
    out - 将编写消息写入其中的ByteBuf
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - allocateBuffer
```
protected final ByteBuf allocateBuffer(ChannelHandlerContext ctx,
                                       ByteBuf msg,
                                       boolean preferDirect)
                                throws java.lang.Exception
```
    从类复制的描述： MessageToByteEncoder
    
    分配ByteBuf ，其将被用作参数的#encode(ChannelHandlerContext, I, ByteBuf) 。子类可以覆盖此方法返回ByteBuf与完美匹配initialCapacity 。
    
    重写：
    
    allocateBuffer在课堂 MessageToByteEncoder<ByteBuf>
    
    异常
    
    java.lang.Exception
  - close
```
public void close(ChannelHandlerContext ctx,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从类复制的描述： ChannelOutboundHandlerAdapter
    
    致电ChannelOutboundInvoker.close(ChannelPromise)转发到ChannelOutboundHandler中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    close在界面 ChannelOutboundHandler
    
    重写：
    
    close ChannelOutboundHandlerAdapter
    
    参数
    
    ctx - 关闭操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - handlerAdded
```
public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerAdded在界面 ChannelHandler
    
    重写：
    
    handlerAdded在课堂上 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception

Class JdkZlibEncoder

Nested Class Summary

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

构造方法摘要

方法摘要

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

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

构造方法详细信息

JdkZlibEncoder

JdkZlibEncoder

JdkZlibEncoder

JdkZlibEncoder

JdkZlibEncoder

JdkZlibEncoder

方法详细信息

close

close

isClosed

encode

allocateBuffer

close

handlerAdded