java.lang.Object
- io.netty.handler.codec.compression.InputBufferingDecompressor
- - io.netty.handler.codec.compression.JdkZlibDecompressor

All Implemented Interfaces:

Decompressor, java.lang.AutoCloseable
```
@UnstableApi
public final class JdkZlibDecompressor
extends InputBufferingDecompressor
```
Decompress a ByteBuf using the inflate algorithm.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class JdkZlibDecompressor.Builder

private static class JdkZlibDecompressor.GzipState
- Nested classes/interfaces inherited from interface io.netty.handler.codec.compression.Decompressor
  Decompressor.AbstractDecompressorBuilder, Decompressor.Status

Field Summary

Fields
Modifier and Type	Field	Description
`private ByteBufChecksum`	`crc`
`private boolean`	`decideZlibOrNone`
`private boolean`	`decompressConcatenated`
`private byte[]`	`dictionary`
`private static int`	`FCOMMENT`
`private static int`	`FEXTRA`
`private static int`	`FHCRC`
`private boolean`	`finished`
`private int`	`flags`
`private static int`	`FNAME`
`private static int`	`FRESERVED`
`private boolean`	`gzipMemberFinished`
`private JdkZlibDecompressor.GzipState`	`gzipState`
`private java.util.zip.Inflater`	`inflater`
`private boolean`	`inflaterHasPendingOutput`	If this is true, the last `Inflater.inflate(byte[], int, int)` filled the output buffer completely, so the inflater may still hold decoded data even if `Inflater.needsInput()` reports that all input was consumed.
`private boolean`	`inputBufferInInflater`	If this is true, part of the input buffer is still in use by the `inflater`, so we shouldn't touch that buffer too much (e.g.
`private int`	`maxAllocation`
`private static int`	`MIN_OUTPUT_BUFFER_SIZE`	Smallest output buffer we hand to `Inflater.inflate(byte[], int, int)`.
`private int`	`xlen`

Fields inherited from class io.netty.handler.codec.compression.InputBufferingDecompressor
allocator

Constructor Summary

Constructors
Constructor Description

JdkZlibDecompressor(JdkZlibDecompressor.Builder builder, ByteBufAllocator allocator)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static JdkZlibDecompressor.Builder`	`builder()`
`void`	`close()`	Close this decompressor, cleaning up any associated resources.
`private void`	`consumeInput(ByteBuf buf)`
`void`	`endOfInput()`	Notify the decompressor that the end of input has been reached.
`private boolean`	`handleGzipFooter(ByteBuf in)`
`private static boolean`	`looksLikeZlib(short cmf_flg)`
`(package private) void`	`processInput(ByteBuf buf)`	Process some input.
`(package private) ByteBuf`	`processOutput(ByteBuf buf)`	Produce some output.
`private boolean`	`readGZIPFooter(ByteBuf in)`	Read the GZIP footer.
`private boolean`	`readGZIPHeader(ByteBuf in)`
`private boolean`	`skipIfNeeded(ByteBuf in, int flagMask)`	Skip bytes in the input if needed until we find the end marker `0x00`.
`Decompressor.Status`	`status()`	Get the current status.
`private boolean`	`verifyCrc(ByteBuf in)`	Verifies CRC.
`private boolean`	`verifyCrc16(ByteBuf in)`

Methods inherited from class io.netty.handler.codec.compression.InputBufferingDecompressor
addInput, available, takeOutput

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FHCRC
```
private static final int FHCRC
```
    See Also:
    
    Constant Field Values
  - FEXTRA
```
private static final int FEXTRA
```
    See Also:
    
    Constant Field Values
  - FNAME
```
private static final int FNAME
```
    See Also:
    
    Constant Field Values
  - FCOMMENT
```
private static final int FCOMMENT
```
    See Also:
    
    Constant Field Values
  - FRESERVED
```
private static final int FRESERVED
```
    See Also:
    
    Constant Field Values
  - MIN_OUTPUT_BUFFER_SIZE
```
private static final int MIN_OUTPUT_BUFFER_SIZE
```
    Smallest output buffer we hand to Inflater.inflate(byte[], int, int). The number of remaining input bytes is only a hint for how much output to expect: the inflater may still hold decoded data that did not fit into the previous output buffer, and by then it may have consumed all input bytes already (Inflater.getRemaining() == 0). Inflating into a zero-sized buffer can never make progress.
    
    See Also:
    
    Constant Field Values
  - inflater
```
private java.util.zip.Inflater inflater
```
  - maxAllocation
```
private final int maxAllocation
```
  - dictionary
```
private final byte[] dictionary
```
  - crc
```
private final ByteBufChecksum crc
```
  - decompressConcatenated
```
private final boolean decompressConcatenated
```
  - gzipState
```
private JdkZlibDecompressor.GzipState gzipState
```
  - flags
```
private int flags
```
  - xlen
```
private int xlen
```
  - decideZlibOrNone
```
private boolean decideZlibOrNone
```
  - finished
```
private boolean finished
```
  - gzipMemberFinished
```
private boolean gzipMemberFinished
```
  - inputBufferInInflater
```
private boolean inputBufferInInflater
```
    If this is true, part of the input buffer is still in use by the inflater, so we shouldn't touch that buffer too much (e.g. compact it).
  - inflaterHasPendingOutput
```
private boolean inflaterHasPendingOutput
```
    If this is true, the last Inflater.inflate(byte[], int, int) filled the output buffer completely, so the inflater may still hold decoded data even if Inflater.needsInput() reports that all input was consumed.
- Constructor Detail
  - JdkZlibDecompressor
```
JdkZlibDecompressor(JdkZlibDecompressor.Builder builder,
                    ByteBufAllocator allocator)
```
- Method Detail
  - status
```
public Decompressor.Status status()
                           throws DecompressionException
```
    Description copied from interface: Decompressor
    
    Get the current status. Like the other operations on this class, calling this method is not permitted if the decompressor has failed or was closed.
    
    Returns:
    
    The current status
    
    Throws:
    
    DecompressionException
  - endOfInput
```
public void endOfInput()
                throws DecompressionException
```
    Description copied from interface: Decompressor
    
    Notify the decompressor that the end of input has been reached. Some implementations may flush remaining data or throw an exception if the input is truncated, but most implementations do nothing. Only permitted for Decompressor.Status.NEED_INPUT.
    
    Throws:
    
    DecompressionException
  - processInput
```
void processInput(ByteBuf buf)
           throws DecompressionException
```
    Description copied from class: InputBufferingDecompressor
    
    Process some input. The input buffer ownership does not transfer to this method: If there's still data unread after this method finishes, it will be buffered.
    
    Specified by:
    
    processInput in class InputBufferingDecompressor
    
    Parameters:
    
    buf - The input buffer
    
    Throws:
    
    DecompressionException
  - consumeInput
```
private void consumeInput(ByteBuf buf)
```
  - processOutput
```
ByteBuf processOutput(ByteBuf buf)
               throws DecompressionException
```
    Description copied from class: InputBufferingDecompressor
    
    Produce some output. The input buffer parameter may be read from to consume some more data, but note that this method must return a buffer even if the input is too short.
    
    Specified by:
    
    processOutput in class InputBufferingDecompressor
    
    Parameters:
    
    buf - The input buffer
    
    Throws:
    
    DecompressionException
  - handleGzipFooter
```
private boolean handleGzipFooter(ByteBuf in)
```
  - readGZIPHeader
```
private boolean readGZIPHeader(ByteBuf in)
```
  - skipIfNeeded
```
private boolean skipIfNeeded(ByteBuf in,
                             int flagMask)
```
    Skip bytes in the input if needed until we find the end marker 0x00.
    
    Parameters:
    
    in - the input
    
    flagMask - the mask that should be present in the flags when we need to skip bytes.
    
    Returns:
    
    true if the operation is complete and we can move to the next state, false if we need the retry again once we have more readable bytes.
  - readGZIPFooter
```
private boolean readGZIPFooter(ByteBuf in)
```
    Read the GZIP footer.
    
    Parameters:
    
    in - the input.
    
    Returns:
    
    true if the footer could be read, false if the read could not be performed as the input ByteBuf doesn't have enough readable bytes (8 bytes).
  - verifyCrc
```
private boolean verifyCrc(ByteBuf in)
```
    Verifies CRC.
    
    Parameters:
    
    in - the input.
    
    Returns:
    
    true if verification could be performed, false if verification could not be performed as the input ByteBuf doesn't have enough readable bytes (4 bytes).
  - verifyCrc16
```
private boolean verifyCrc16(ByteBuf in)
```
  - looksLikeZlib
```
private static boolean looksLikeZlib(short cmf_flg)
```
  - close
```
public void close()
```
    Description copied from interface: Decompressor
    
    Close this decompressor, cleaning up any associated resources. This method is idempotent.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface Decompressor
    
    Overrides:
    
    close in class InputBufferingDecompressor
  - builder
```
@UnstableApi
public static JdkZlibDecompressor.Builder builder()
```

Modifier and Type	Class	Description
`static class`	`JdkZlibDecompressor.Builder`
`private static class`	`JdkZlibDecompressor.GzipState`

Class JdkZlibDecompressor

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.handler.codec.compression.Decompressor

Field Summary

Fields inherited from class io.netty.handler.codec.compression.InputBufferingDecompressor

Constructor Summary

Method Summary

Methods inherited from class io.netty.handler.codec.compression.InputBufferingDecompressor

Methods inherited from class java.lang.Object

Field Detail

FHCRC

FEXTRA

FNAME

FCOMMENT

FRESERVED

MIN_OUTPUT_BUFFER_SIZE

inflater

maxAllocation

dictionary

crc

decompressConcatenated

gzipState

flags

xlen

decideZlibOrNone

finished

gzipMemberFinished

inputBufferInInflater

inflaterHasPendingOutput

Constructor Detail

JdkZlibDecompressor

Method Detail

status

endOfInput

processInput

consumeInput

processOutput

handleGzipFooter

readGZIPHeader

skipIfNeeded

readGZIPFooter

verifyCrc

verifyCrc16

looksLikeZlib

close

builder