Package io.netty.handler.codec.compression

Class JZlibDecoder

  • All Implemented Interfaces:
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    public class JZlibDecoder
extends ZlibDecoder

    • 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

    • 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)  
      protected void decompressionBufferExhausted​(io.netty.buffer.ByteBuf buffer)
      Called when the decompression buffer cannot be expanded further.
      boolean isClosed()
      Returns true if and only if the end of the compressed stream has been reached.

      • 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

      • JZlibDecoder

        public JZlibDecoder​(int maxAllocation)
        Creates a new instance with the default wrapper (ZlibWrapper.ZLIB) and specified maximum buffer allocation.
        Parameters:
        maxAllocation - Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the ByteBufAllocator.
        Throws:
        DecompressionException - if failed to initialize zlib

      • JZlibDecoder

        public JZlibDecoder​(ZlibWrapper wrapper,
                    int maxAllocation)
        Creates a new instance with the specified wrapper and maximum buffer allocation.
        Parameters:
        maxAllocation - Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the ByteBufAllocator.
        Throws:
        DecompressionException - if failed to initialize zlib

      • JZlibDecoder

        public JZlibDecoder​(byte[] dictionary,
                    int maxAllocation)
        Creates a new instance with the specified preset dictionary and maximum buffer allocation. The wrapper is always ZlibWrapper.ZLIB because it is the only format that supports the preset dictionary.
        Parameters:
        maxAllocation - Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is decided by the ByteBufAllocator.
        Throws:
        DecompressionException - if failed to initialize zlib

    • Method Detail

      • isClosed

        public boolean isClosed()
        Returns true if and only if the end of the compressed stream has been reached.
        Specified by:
        isClosed in class ZlibDecoder

      • 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

      • decompressionBufferExhausted

        protected void decompressionBufferExhausted​(io.netty.buffer.ByteBuf buffer)
        Description copied from class: ZlibDecoder
        Called when the decompression buffer cannot be expanded further. Default implementation is a no-op, but subclasses can override in case they want to do something before the DecompressionException is thrown, such as log the data that was decompressed so far.
        Overrides:
        decompressionBufferExhausted in class ZlibDecoder