Lz4FrameDecoder (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.handler.codec.ByteToMessageDecoder
    - - io.netty.handler.codec.compression.Lz4FrameDecoder

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler
```
public class Lz4FrameDecoder
extends ByteToMessageDecoder
```
解压缩用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 class io.netty.handler.codec.ByteToMessageDecoder
  ByteToMessageDecoder.Cumulator
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

Field Summary
- Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
  COMPOSITE_CUMULATOR, MERGE_CUMULATOR

构造方法摘要

构造方法
Constructor and Description
`Lz4FrameDecoder()` 创建最快的LZ4解码器。
`Lz4FrameDecoder(boolean validateChecksums)` 用您的机器上最快的解码器实例创建LZ4解码器。
`Lz4FrameDecoder(LZ4Factory factory, boolean validateChecksums)` 用可定制的实现创建一个新的LZ4解码器。
`Lz4FrameDecoder(LZ4Factory factory, java.util.zip.Checksum checksum)` 创建一个新的可定制的LZ4解码器。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`protected void`	`decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)` 解码从一个`ByteBuf`到另一个。
`boolean`	`isClosed()` 当且仅当已达到压缩流的结束时才返回 `true` 。

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

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

- 构造方法详细信息
  - Lz4FrameDecoder
```
public Lz4FrameDecoder()
```
    创建最快的LZ4解码器。请注意，默认情况下，每个块中校验和标题的验证都会禁用，以提高性能。如果性能不是问题，或者您希望验证校验带来的安全性，请使用参数设置为true的Lz4FrameDecoder(boolean)构造函数。
  - Lz4FrameDecoder
```
public Lz4FrameDecoder(boolean validateChecksums)
```
    用您的机器上最快的解码器实例创建LZ4解码器。
    
    参数
    
    validateChecksums - 如果true ，校验和字段将根据实际的未压缩数据进行验证，如果校验和不匹配，则会引发合适的DecompressionException
  - Lz4FrameDecoder
```
public Lz4FrameDecoder(LZ4Factory factory,
                       boolean validateChecksums)
```
    用可定制的实现创建一个新的LZ4解码器。
    
    参数
    
    factory - 用户可定制的 LZ4Factory实例，它可能是JNI绑定到原始C实现，纯Java实现或使用 Unsafe的Java实现
    
    validateChecksums - 如果true ，校验和字段将根据实际的未压缩数据进行验证，如果校验和不匹配，则会引发合适的DecompressionException 。在这种情况下，编码器将使用基于Yann Collet在Github处提供的工作的xxhash hashing for Java。
  - Lz4FrameDecoder
```
public Lz4FrameDecoder(LZ4Factory factory,
                       java.util.zip.Checksum checksum)
```
    创建一个新的可定制的LZ4解码器。
    
    参数
    
    factory - 用户可定制的 LZ4Factory实例，它可以是JNI绑定到原始C实现，纯Java实现或使用 Unsafe的Java实现
    
    checksum - 用于检查数据完整性的Checksum实例。如果您不想验证每个块的校验和，则可以设置null
- 方法详细信息
  - decode
```
protected void decode(ChannelHandlerContext ctx,
                      ByteBuf in,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception
```
    从类复制的描述： ByteToMessageDecoder
    
    解码从一个ByteBuf到另一个。该方法将被调用，直到输入ByteBuf在从此方法返回时没有任何可读的内容或直到从输入ByteBuf中没有读取任何内容。
    
    Specified by:
    
    decode在课程 ByteToMessageDecoder
    
    参数
    
    ctx - ByteToMessageDecoder所属的ChannelHandlerContext
    
    in - 从中读取数据的ByteBuf
    
    out - 应该添加解码消息的 List
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - isClosed
```
public boolean isClosed()
```
    Returns true if and only if the end of the compressed stream has been reached.

Class Lz4FrameDecoder

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

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

Field Summary

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder

构造方法摘要

方法摘要

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

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

构造方法详细信息

Lz4FrameDecoder

Lz4FrameDecoder

Lz4FrameDecoder

Lz4FrameDecoder

方法详细信息

decode

isClosed