Class Lz4FrameDecoder

java.lang.Object
io.netty.channel.ChannelHandlerAdapter
All Implemented Interfaces:
ChannelHandler, ChannelInboundHandler
public class Lz4FrameDecoder extends ByteToMessageDecoder
Uncompresses a ByteBuf encoded with the LZ4 format. See original LZ4 Github project and LZ4 block format for full description. Since the original LZ4 block format does not contains size of compressed block and size of original data this encoder uses format like LZ4 Java library written by Adrien Grand and approved by Yann Collet (author of original LZ4 library). * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Magic * Token * Compressed * Decompressed * Checksum * + * LZ4 compressed * * * * length * length * * * block * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

  • Constructor Details

    • Lz4FrameDecoder

      public Lz4FrameDecoder()
      Creates the fastest LZ4 decoder. Note that by default, validation of the checksum header in each chunk is DISABLED for performance improvements. If performance is less of an issue, or if you would prefer the safety that checksum validation brings, please use the Lz4FrameDecoder(boolean) constructor with the argument set to true.

    • Lz4FrameDecoder

      public Lz4FrameDecoder(boolean validateChecksums)
      Creates a LZ4 decoder with fastest decoder instance available on your machine.
      Parameters:
      validateChecksums - if true, the checksum field will be validated against the actual uncompressed data, and if the checksums do not match, a suitable DecompressionException will be thrown

    • Lz4FrameDecoder

      public Lz4FrameDecoder(net.jpountz.lz4.LZ4Factory factory, boolean validateChecksums)
      Creates a new LZ4 decoder with customizable implementation.
      Parameters:
      factory - user customizable LZ4Factory instance which may be JNI bindings to the original C implementation, a pure Java implementation or a Java implementation that uses the Unsafe
      validateChecksums - if true, the checksum field will be validated against the actual uncompressed data, and if the checksums do not match, a suitable DecompressionException will be thrown. In this case encoder will use xxhash hashing for Java, based on Yann Collet's work available at Github.

    • Lz4FrameDecoder

      public Lz4FrameDecoder(net.jpountz.lz4.LZ4Factory factory, Checksum checksum)
      Creates a new customizable LZ4 decoder.
      Parameters:
      factory - user customizable LZ4Factory instance which may be JNI bindings to the original C implementation, a pure Java implementation or a Java implementation that uses the Unsafe
      checksum - the Checksum instance to use to check data for integrity. You may set null if you do not want to validate checksum of each block

  • Method Details