Lz4FrameEncoder (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.Lz4FrameEncoder

All Implemented Interfaces:

ChannelHandler ， ChannelOutboundHandler
```
public class Lz4FrameEncoder
extends MessageToByteEncoder<ByteBuf>
```
使用LZ4格式压缩ByteBuf 。请参阅原始LZ4 Github project和LZ4 block format以获取完整说明。由于原始的LZ4块格式不包含压缩块的大小和原始数据的大小，所以该编码器使用由Adrien Grand编写并由Yann Collet（原始LZ4库的作者）批准的格式LZ4 Java库。 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Magic * Token * Compressed * Decompressed * Checksum * * * LZ4压缩* * * *长度*长度* * *块* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

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

构造方法摘要

构造方法
Constructor and Description
`Lz4FrameEncoder()` 根据Yann Collet的作品 Github ，创建最快的LZ4编码器，其默认块大小（64 KB）和Java的xxhash哈希。
`Lz4FrameEncoder(boolean highCompressor)` 根据Yann Collet的工作成果Github ，创建了一个新的LZ4编码器，它具有高或高压缩，默认块大小（64 KB）和Java的xxhash哈希。
`Lz4FrameEncoder(LZ4Factory factory, boolean highCompressor, int blockSize, java.util.zip.Checksum checksum)` 创建一个新的可定制的LZ4编码器。
`Lz4FrameEncoder(LZ4Factory factory, boolean highCompressor, int blockSize, java.util.zip.Checksum checksum, int maxEncodeSize)` 创建一个新的可定制的LZ4编码器。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`protected ByteBuf`	`allocateBuffer(ChannelHandlerContext ctx, ByteBuf msg, boolean preferDirect)` 分配一个`ByteBuf` ，它将用作`#encode(ChannelHandlerContext, I, ByteBuf)`参数。
`ChannelFuture`	`close()` 关闭此`Lz4FrameEncoder`并完成编码。
`void`	`close(ChannelHandlerContext ctx, ChannelPromise promise)` 致电`ChannelOutboundInvoker.close(ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`ChannelFuture`	`close(ChannelPromise promise)` 关闭此`Lz4FrameEncoder`并完成编码。
`protected void`	`encode(ChannelHandlerContext ctx, ByteBuf in, ByteBuf out)` 将消息编码成`ByteBuf` 。
`void`	`flush(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.flush()`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`handlerAdded(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`void`	`handlerRemoved(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, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, exceptionCaught, 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

- 构造方法详细信息
  - Lz4FrameEncoder
```
public Lz4FrameEncoder()
```
    根据Yann Collet在 Github提供的工作，创建最快的LZ4编码器，默认块大小（64 KB）和Java的xxhash散列。
  - Lz4FrameEncoder
```
public Lz4FrameEncoder(boolean highCompressor)
```
    根据Yann Collet在 Github处提供的工作，创建了一个新的LZ4编码器，该编码器具有高或快速压缩，默认块大小（64 KB）和Java的xxhash哈希。
    
    参数
    
    highCompressor - 如果 true编解码器将使用需要更多内存且速度较慢但压缩更有效的压缩器
  - Lz4FrameEncoder
```
public Lz4FrameEncoder(LZ4Factory factory,
                       boolean highCompressor,
                       int blockSize,
                       java.util.zip.Checksum checksum)
```
    创建一个新的可定制的LZ4编码器。
    
    参数
    
    factory - 用户可定制的 LZ4Factory实例，它可以是JNI绑定到原始C实现，纯Java实现或使用 Unsafe的Java实现
    
    highCompressor - 如果 true编解码器将使用需要更多内存且速度较慢但压缩效率更高的压缩器
    
    blockSize - 一次尝试压缩的最大字节数必须> = 64且<= 32 M
    
    checksum - 用于检查数据完整性的 Checksum实例
  - Lz4FrameEncoder
```
public Lz4FrameEncoder(LZ4Factory factory,
                       boolean highCompressor,
                       int blockSize,
                       java.util.zip.Checksum checksum,
                       int maxEncodeSize)
```
    创建一个新的可定制的LZ4编码器。
    
    参数
    
    factory - 用户可定制的 LZ4Factory实例，它可以是JNI绑定到原始C实现，纯Java实现或使用 Unsafe的Java实现
    
    highCompressor - 如果 true编解码器将使用需要更多内存且速度较慢但压缩效率更高的压缩器
    
    blockSize - 一次尝试压缩的最大字节数必须> = 64且<= 32 M
    
    checksum - 用于检查数据完整性的 Checksum实例
    
    maxEncodeSize - 编码（压缩）缓冲区的最大大小
- 方法详细信息
  - allocateBuffer
```
protected ByteBuf allocateBuffer(ChannelHandlerContext ctx,
                                 ByteBuf msg,
                                 boolean preferDirect)
```
    从类复制的描述： MessageToByteEncoder
    
    分配一个ByteBuf ，它将用作#encode(ChannelHandlerContext, I, ByteBuf)参数。子类可以覆盖此方法以返回ByteBuf，并具有完美匹配initialCapacity 。
    
    重写：
    
    allocateBuffer在课程 MessageToByteEncoder<ByteBuf>
  - encode
```
protected void encode(ChannelHandlerContext ctx,
                      ByteBuf in,
                      ByteBuf out)
               throws java.lang.Exception
```
    将消息编码成ByteBuf 。这个方法将被编码器处理的每个书面信息调用。将输入缓冲区编码为输出缓冲区中的blockSize块。只有当我们点击blockSize时数据才会被压缩和写入; 否则，它被复制到后台buffer以等待更多数据。
    
    Specified by:
    
    encode在课堂上 MessageToByteEncoder<ByteBuf>
    
    参数
    
    ctx - 这MessageToByteEncoder所属的ChannelHandlerContext
    
    in - 要编码的消息
    
    out - 将编写消息写入其中的ByteBuf
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - flush
```
public void flush(ChannelHandlerContext ctx)
           throws java.lang.Exception
```
    从类复制的描述： ChannelOutboundHandlerAdapter
    
    致电ChannelHandlerContext.flush()转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    flush在界面 ChannelOutboundHandler
    
    重写：
    
    flush在课堂 ChannelOutboundHandlerAdapter
    
    参数
    
    ctx - 进行冲洗操作的ChannelHandlerContext
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - isClosed
```
public boolean isClosed()
```
    当且仅当压缩流已完成时返回 true 。
  - close
```
public ChannelFuture close()
```
    关闭此Lz4FrameEncoder并完成编码。操作完成后，会通知返回的ChannelFuture 。
  - close
```
public ChannelFuture close(ChannelPromise promise)
```
    关闭此Lz4FrameEncoder并完成编码。一旦操作完成，给定的ChannelFuture将会收到通知，并且还将返回。
  - close
```
public void close(ChannelHandlerContext ctx,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从类复制的描述： ChannelOutboundHandlerAdapter
    
    致电ChannelOutboundInvoker.close(ChannelPromise)转发至ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    close ，界面 ChannelOutboundHandler
    
    重写：
    
    close在课堂上 ChannelOutboundHandlerAdapter
    
    参数
    
    ctx - 关闭操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - handlerAdded
```
public void handlerAdded(ChannelHandlerContext ctx)
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerAdded在界面 ChannelHandler
    
    重写：
    
    handlerAdded在课堂上 ChannelHandlerAdapter
  - handlerRemoved
```
public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerRemoved在界面 ChannelHandler
    
    重写：
    
    handlerRemoved在课堂 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception

Class Lz4FrameEncoder

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

构造方法详细信息

Lz4FrameEncoder

Lz4FrameEncoder

Lz4FrameEncoder

Lz4FrameEncoder

方法详细信息

allocateBuffer

encode

flush

isClosed

close

close

close

handlerAdded

handlerRemoved