Modifier and Type	Class and Description
private static enum	GZIPContentDecoder.State

Field Summary

Modifier and Type	Field and Description
private final int	_bufferSize
private byte	_flags
private RetainableByteBuffer	_inflated
private final List<RetainableByteBuffer>	_inflateds
private Inflater	_inflater
private CompressionPool<Inflater>.Entry	_inflaterEntry
private final ByteBufferPool	_pool
private int	_size
private GZIPContentDecoder.State	_state
private long	_value
private static final long	UINT_MAX

Constructor Summary

Access	Constructor and Description
public	GZIPContentDecoder()
public	GZIPContentDecoder(int bufferSize)
public	GZIPContentDecoder(ByteBufferPool byteBufferPool, int bufferSize)
public	GZIPContentDecoder(InflaterPool inflaterPool, ByteBufferPool byteBufferPool, int bufferSize)

Method Summary

Modifier and Type	Method and Description
public RetainableByteBuffer	Returns: a heap buffer of the configured capacity either from the pool or freshly allocated. acquire(int capacity of the ByteBuffer to acquire capacity)
public RetainableByteBuffer	Returns: a buffer containing inflated data. decode(ByteBuffer the buffer containing compressed data. compressed) Inflates compressed data from a buffer.
protected void	decodeChunks(ByteBuffer the buffer of compressed data to inflate compressed) Inflates compressed data.
protected boolean	Returns: false if inflating should continue, or true if the call to `decodeChunks(ByteBuffer)` or `decode(ByteBuffer)` should return, allowing to consume the inflated chunk and apply backpressure decodedChunk(RetainableByteBuffer the inflated chunk of data chunk) Called when a chunk of data is inflated.
public void	destroy() Implements org.eclipse.jetty.util.component.Destroyable.destroy.
public boolean	isFinished()
private void	reset()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_bufferSize	back to summary
private final int _bufferSize

_flags	back to summary
private byte _flags

_inflated	back to summary
private RetainableByteBuffer _inflated

_inflateds	back to summary
private final List<RetainableByteBuffer> _inflateds

_inflater	back to summary
private Inflater _inflater

_inflaterEntry	back to summary
private CompressionPool<Inflater>.Entry _inflaterEntry

_pool	back to summary
private final ByteBufferPool _pool

_size	back to summary
private int _size

_state	back to summary
private GZIPContentDecoder.State _state

_value	back to summary
private long _value

UINT_MAX	back to summary
private static final long UINT_MAX

Constructor Detail

GZIPContentDecoder	back to summary
public GZIPContentDecoder()

GZIPContentDecoder	back to summary
public GZIPContentDecoder(int bufferSize)

GZIPContentDecoder	back to summary
public GZIPContentDecoder(ByteBufferPool byteBufferPool, int bufferSize)

GZIPContentDecoder	back to summary
public GZIPContentDecoder(InflaterPool inflaterPool, ByteBufferPool byteBufferPool, int bufferSize)

Method Detail

acquire	back to summary
public RetainableByteBuffer acquire(int capacity) Parameters capacity:int capacity of the ByteBuffer to acquire Returns:RetainableByteBuffer a heap buffer of the configured capacity either from the pool or freshly allocated.

decode back to summary

decode	back to summary
public RetainableByteBuffer decode(ByteBuffer compressed) Inflates compressed data from a buffer. The `RetainableByteBuffer` returned by this method must be released via `RetainableByteBuffer#release()`. This method may fully consume the input buffer, but return only a chunk of the inflated bytes, to allow applications to consume the inflated chunk before performing further inflation, applying backpressure. In this case, this method should be invoked again with the same input buffer (even if it's already fully consumed) and that will produce another chunk of inflated bytes. Termination happens when the input buffer is fully consumed, and the returned buffer is empty. See `decodedChunk(RetainableByteBuffer)` to perform inflating in a non-blocking way that allows to apply backpressure. Parameters compressed:ByteBuffer the buffer containing compressed data. Returns:RetainableByteBuffer a buffer containing inflated data.

public RetainableByteBuffer decode(ByteBuffer compressed)

Inflates compressed data from a buffer.

The RetainableByteBuffer returned by this method must be released via RetainableByteBuffer#release().

This method may fully consume the input buffer, but return only a chunk of the inflated bytes, to allow applications to consume the inflated chunk before performing further inflation, applying backpressure. In this case, this method should be invoked again with the same input buffer (even if it's already fully consumed) and that will produce another chunk of inflated bytes. Termination happens when the input buffer is fully consumed, and the returned buffer is empty.

See decodedChunk(RetainableByteBuffer) to perform inflating in a non-blocking way that allows to apply backpressure.

Parameters

compressed:ByteBuffer: the buffer containing compressed data.

Returns:RetainableByteBuffer

a buffer containing inflated data.

decodeChunks back to summary

decodeChunks	back to summary
protected void decodeChunks(ByteBuffer compressed) Inflates compressed data. Inflation continues until the compressed block end is reached, there is no more compressed data or a call to `decodedChunk(RetainableByteBuffer)` returns true. Parameters compressed:ByteBuffer the buffer of compressed data to inflate

protected void decodeChunks(ByteBuffer compressed)

Inflates compressed data.

Inflation continues until the compressed block end is reached, there is no more compressed data or a call to decodedChunk(RetainableByteBuffer) returns true.

Parameters

compressed:ByteBuffer: the buffer of compressed data to inflate

decodedChunk back to summary

decodedChunk	back to summary
protected boolean decodedChunk(RetainableByteBuffer chunk) Called when a chunk of data is inflated. The default implementation aggregates all the chunks into a single buffer returned from `decode(ByteBuffer)`. Derived implementations may choose to consume inflated chunks individually and return `true` from this method to prevent further inflation until a subsequent call to `decode(ByteBuffer)` or `decodeChunks(ByteBuffer)` is made. Parameters chunk:RetainableByteBuffer the inflated chunk of data Returns:boolean false if inflating should continue, or true if the call to `decodeChunks(ByteBuffer)` or `decode(ByteBuffer)` should return, allowing to consume the inflated chunk and apply backpressure

protected boolean decodedChunk(RetainableByteBuffer chunk)

Called when a chunk of data is inflated.

The default implementation aggregates all the chunks into a single buffer returned from decode(ByteBuffer).

Derived implementations may choose to consume inflated chunks individually and return true from this method to prevent further inflation until a subsequent call to decode(ByteBuffer) or decodeChunks(ByteBuffer) is made.

Parameters

chunk:RetainableByteBuffer: the inflated chunk of data

Returns:boolean

false if inflating should continue, or true if the call to decodeChunks(ByteBuffer) or decode(ByteBuffer) should return, allowing to consume the inflated chunk and apply backpressure

destroy	back to summary
public void destroy() Implements org.eclipse.jetty.util.component.Destroyable.destroy. Annotations @Override

destroy

back to summary

public void destroy()

Implements org.eclipse.jetty.util.component.Destroyable.destroy.

Annotations

@Override

isFinished	back to summary
public boolean isFinished()

reset	back to summary
private void reset()

org.eclipse.jetty.http back to summary

private final Enum GZIPContentDecoder.State

Class Inheritance

extends Enum<GZIPContentDecoder.State>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.http.GZIPContentDecoder.State

Field Summary

Modifier and Type	Field and Description
public static final GZIPContentDecoder.State	CM
public static final GZIPContentDecoder.State	COMMENT
public static final GZIPContentDecoder.State	CRC
public static final GZIPContentDecoder.State	DATA
public static final GZIPContentDecoder.State	EXTRA
public static final GZIPContentDecoder.State	EXTRA_LENGTH
public static final GZIPContentDecoder.State	FLAGS
public static final GZIPContentDecoder.State	FLG
public static final GZIPContentDecoder.State	HCRC
public static final GZIPContentDecoder.State	ID
public static final GZIPContentDecoder.State	INITIAL
public static final GZIPContentDecoder.State	ISIZE
public static final GZIPContentDecoder.State	MTIME
public static final GZIPContentDecoder.State	NAME
public static final GZIPContentDecoder.State	OS
public static final GZIPContentDecoder.State	XFL

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static GZIPContentDecoder.State	valueOf(String name)
public static GZIPContentDecoder.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CM	back to summary
public static final GZIPContentDecoder.State CM

COMMENT	back to summary
public static final GZIPContentDecoder.State COMMENT

CRC	back to summary
public static final GZIPContentDecoder.State CRC

DATA	back to summary
public static final GZIPContentDecoder.State DATA

EXTRA	back to summary
public static final GZIPContentDecoder.State EXTRA

EXTRA_LENGTH	back to summary
public static final GZIPContentDecoder.State EXTRA_LENGTH

FLAGS	back to summary
public static final GZIPContentDecoder.State FLAGS

FLG	back to summary
public static final GZIPContentDecoder.State FLG

HCRC	back to summary
public static final GZIPContentDecoder.State HCRC

ID	back to summary
public static final GZIPContentDecoder.State ID

INITIAL	back to summary
public static final GZIPContentDecoder.State INITIAL

ISIZE	back to summary
public static final GZIPContentDecoder.State ISIZE

MTIME	back to summary
public static final GZIPContentDecoder.State MTIME

NAME	back to summary
public static final GZIPContentDecoder.State NAME

OS	back to summary
public static final GZIPContentDecoder.State OS

XFL	back to summary
public static final GZIPContentDecoder.State XFL

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static GZIPContentDecoder.State valueOf(String name)

values	back to summary
public static GZIPContentDecoder.State[] values()

public Class GZIPContentDecoder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum GZIPContentDecoder.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail