Package io.netty.handler.codec.compression

Class FastLzFrameDecoder

  • All Implemented Interfaces:
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    public class FastLzFrameDecoder
extends io.netty.handler.codec.ByteToMessageDecoder
    Uncompresses a ByteBuf encoded by FastLzFrameEncoder using the FastLZ algorithm. See FastLZ format.

    • Nested Class Summary

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

        io.netty.handler.codec.ByteToMessageDecoder.Cumulator

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

        io.netty.channel.ChannelHandler.Sharable

    • Field Summary

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

        COMPOSITE_CUMULATOR, MERGE_CUMULATOR

    • Constructor Summary

      Constructors 
      Constructor Description
      FastLzFrameDecoder()
      Creates the fastest FastLZ decoder without checksum calculation.
      FastLzFrameDecoder​(boolean validateChecksums)
      Creates a FastLZ decoder with calculation of checksums as specified.
      FastLzFrameDecoder​(Checksum checksum)
      Creates a FastLZ decoder with specified checksum calculator.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void decode​(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, List<Object> out)  

      • 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 interface io.netty.channel.ChannelHandler

        handlerAdded

    • Constructor Detail

      • FastLzFrameDecoder

        public FastLzFrameDecoder()
        Creates the fastest FastLZ decoder without checksum calculation.

      • FastLzFrameDecoder

        public FastLzFrameDecoder​(boolean validateChecksums)
        Creates a FastLZ decoder with calculation of checksums as specified.
        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. Note, that in this case decoder will use Adler32 as a default checksum calculator.

      • FastLzFrameDecoder

        public FastLzFrameDecoder​(Checksum checksum)
        Creates a FastLZ decoder with specified checksum calculator.
        Parameters:
        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 Detail

      • decode

        protected void decode​(io.netty.channel.ChannelHandlerContext ctx,
                      io.netty.buffer.ByteBuf in,
                      List<Object> out)
               throws Exception
        Specified by:
        decode in class io.netty.handler.codec.ByteToMessageDecoder
        Throws:
        Exception