Package io.netty.handler.codec.compression

Class SnappyFrameDecoder

  • All Implemented Interfaces:
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    Direct Known Subclasses:
    SnappyFramedDecoder
    public class SnappyFrameDecoder
extends io.netty.handler.codec.ByteToMessageDecoder
    Uncompresses a ByteBuf encoded with the Snappy framing format. See Snappy framing format. 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 SnappyFrameDecoder(boolean) constructor with the argument set to true.

    • 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
      SnappyFrameDecoder()
      Creates a new snappy-framed decoder with validation of checksums turned OFF.
      SnappyFrameDecoder​(boolean validateChecksums)
      Creates a new snappy-framed decoder with validation of checksums as specified.

    • 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

      • SnappyFrameDecoder

        public SnappyFrameDecoder()
        Creates a new snappy-framed decoder with validation of checksums turned OFF. To turn checksum validation on, please use the alternate SnappyFrameDecoder(boolean) constructor.

      • SnappyFrameDecoder

        public SnappyFrameDecoder​(boolean validateChecksums)
        Creates a new snappy-framed decoder with validation 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

    • 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