Netty/Codec/HTTP2 4.1.107.Final · io.netty.handler.codec.http2.CompressorHttp2ConnectionEncoder

Modifier and Type	Field and Description
private BrotliOptions	brotliOptions
private int	compressionLevel
public static final int	DEFAULT_COMPRESSION_LEVEL
public static final int	DEFAULT_MEM_LEVEL
public static final int	DEFAULT_WINDOW_BITS
private DeflateOptions	deflateOptions
private GzipOptions	gzipCompressionOptions
private int	memLevel
private final Http2Connection.PropertyKey	propertyKey
private SnappyOptions	snappyOptions
private final boolean	supportsCompressionOptions
private int	windowBits
private ZstdOptions	zstdOptions

Access	Constructor and Description
public	CompressorHttp2ConnectionEncoder(Http2ConnectionEncoder delegate) Create a new `CompressorHttp2ConnectionEncoder` instance with default implementation of `StandardCompressionOptions`
public	CompressorHttp2ConnectionEncoder(Http2ConnectionEncoder delegate, int compressionLevel, int windowBits, int memLevel) Deprecated Create a new `CompressorHttp2ConnectionEncoder` instance
public	CompressorHttp2ConnectionEncoder(Http2ConnectionEncoder delegate, CompressionOptions... compressionOptionsArgs) Create a new `CompressorHttp2ConnectionEncoder` with specified `StandardCompressionOptions`

Method Summary

Modifier and Type	Method and Description
private void	bindCompressorToStream(EmbeddedChannel The compressor associated with the stream identified by `streamId`. compressor, int The stream id for which the headers were written. streamId) Called after the super class has written the headers and created any associated stream objects.
pack-priv void	cleanup(Http2Stream The stream for which `compressor` is the compressor for stream, EmbeddedChannel The compressor for `stream` compressor) Release remaining content from `EmbeddedChannel` and remove the compressor from the `Http2Stream`.
private static CompressionOptions[]	defaultCompressionOptions()
protected CharSequence	Returns: the expected content encoding of the new content. getTargetContentEncoding(CharSequence the value of the `content-encoding` header contentEncoding) Returns the expected content encoding of the decoded content.
private EmbeddedChannel	newCompressionChannel(final ChannelHandlerContext the context. ctx, ZlibWrapper Defines what type of encoder should be used wrapper) Generate a new instance of an `EmbeddedChannel` capable of compressing data
private EmbeddedChannel	Returns: The channel used to compress data. newCompressor(ChannelHandlerContext the context. ctx, Http2Headers Object representing headers which are to be written headers, boolean Indicates if the stream has ended endOfStream) Checks if a new compressor object is needed for the stream identified by `streamId`.
protected EmbeddedChannel	Returns: a new `ByteToMessageDecoder` if the specified encoding is supported. `null` otherwise (alternatively, you can throw a `Http2Exception` to block unknown encoding). newContentCompressor(ChannelHandlerContext the context. ctx, CharSequence the value of the `content-encoding` header contentEncoding) Returns a new `EmbeddedChannel` that encodes the HTTP2 message content encoded in the specified `contentEncoding`.
private static ByteBuf	Returns: The next decoded `ByteBuf` from the `EmbeddedChannel` or `null` if one does not exist nextReadableBuf(EmbeddedChannel The channel to read from compressor) Read the next compressed `ByteBuf` from the `EmbeddedChannel` or `null` if one does not exist.
public ChannelFuture	writeData(final ChannelHandlerContext the context to use for writing. ctx, final int the stream for which to send the frame. streamId, ByteBuf the payload of the frame. This will be released by this method. data, int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). A 1 byte padding is encoded as just the pad length field with value 0. A 256 byte padding is encoded as the pad length field with value 255 and 255 padding bytes appended to the end of the frame. padding, final boolean indicates if this is the last frame to be sent for the stream. endOfStream, ChannelPromise the promise for the write. promise) Overrides io.netty.handler.codec.http2.DecoratingHttp2FrameWriter.writeData. Implements io.netty.handler.codec.http2.Http2DataWriter.writeData. Writes a `DATA` frame to the remote endpoint.
public ChannelFuture	writeHeaders(ChannelHandlerContext the context to use for writing. ctx, int the stream for which to send the frame. streamId, Http2Headers the headers to be sent. headers, int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). padding, boolean indicates if this is the last frame to be sent for the stream. endStream, ChannelPromise the promise for the write. promise) Overrides io.netty.handler.codec.http2.DecoratingHttp2FrameWriter.writeHeaders. Implements io.netty.handler.codec.http2.Http2FrameWriter.writeHeaders. Writes a HEADERS frame to the remote endpoint.
public ChannelFuture	writeHeaders(final ChannelHandlerContext the context to use for writing. ctx, final int the stream for which to send the frame. streamId, final Http2Headers the headers to be sent. headers, final int the stream on which this stream should depend, or 0 if it should depend on the connection. streamDependency, final short the weight for this stream. weight, final boolean whether this stream should be the exclusive dependant of its parent. exclusive, final int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). padding, final boolean indicates if this is the last frame to be sent for the stream. endOfStream, final ChannelPromise the promise for the write. promise) Overrides io.netty.handler.codec.http2.DecoratingHttp2FrameWriter.writeHeaders. Implements io.netty.handler.codec.http2.Http2FrameWriter.writeHeaders. Writes a HEADERS frame with priority specified to the remote endpoint.

Inherited from io.netty.handler.codec.http2.DecoratingHttp2ConnectionEncoder:: connection consumeReceivedSettings flowController frameWriter lifecycleManager pollSentSettings remoteSettings

brotliOptions	back to summary
private BrotliOptions brotliOptions

compressionLevel	back to summary
private int compressionLevel

DEFAULT_COMPRESSION_LEVEL	back to summary
public static final int DEFAULT_COMPRESSION_LEVEL

DEFAULT_MEM_LEVEL	back to summary
public static final int DEFAULT_MEM_LEVEL

DEFAULT_WINDOW_BITS	back to summary
public static final int DEFAULT_WINDOW_BITS

deflateOptions	back to summary
private DeflateOptions deflateOptions

gzipCompressionOptions	back to summary
private GzipOptions gzipCompressionOptions

memLevel	back to summary
private int memLevel

propertyKey	back to summary
private final Http2Connection.PropertyKey propertyKey

snappyOptions	back to summary
private SnappyOptions snappyOptions

supportsCompressionOptions	back to summary
private final boolean supportsCompressionOptions

windowBits	back to summary
private int windowBits

zstdOptions	back to summary
private ZstdOptions zstdOptions

CompressorHttp2ConnectionEncoder	back to summary
public CompressorHttp2ConnectionEncoder(Http2ConnectionEncoder delegate) Create a new `CompressorHttp2ConnectionEncoder` instance with default implementation of `StandardCompressionOptions`

CompressorHttp2ConnectionEncoder	back to summary
public CompressorHttp2ConnectionEncoder(Http2ConnectionEncoder delegate, int compressionLevel, int windowBits, int memLevel) Deprecated Create a new `CompressorHttp2ConnectionEncoder` instance Annotations @Deprecated

CompressorHttp2ConnectionEncoder	back to summary
public CompressorHttp2ConnectionEncoder(Http2ConnectionEncoder delegate, CompressionOptions... compressionOptionsArgs) Create a new `CompressorHttp2ConnectionEncoder` with specified `StandardCompressionOptions`

Method Detail

bindCompressorToStream back to summary

bindCompressorToStream	back to summary
private void bindCompressorToStream(EmbeddedChannel compressor, int streamId) Called after the super class has written the headers and created any associated stream objects. Parameters compressor:EmbeddedChannel The compressor associated with the stream identified by `streamId`. streamId:int The stream id for which the headers were written.

private void bindCompressorToStream(EmbeddedChannel compressor, int streamId)

Called after the super class has written the headers and created any associated stream objects.

Parameters

compressor:EmbeddedChannel: The compressor associated with the stream identified by streamId.
streamId:int: The stream id for which the headers were written.

cleanup back to summary

cleanup	back to summary
pack-priv void cleanup(Http2Stream stream, EmbeddedChannel compressor) Release remaining content from `EmbeddedChannel` and remove the compressor from the `Http2Stream`. Parameters stream:Http2Stream The stream for which `compressor` is the compressor for compressor:EmbeddedChannel The compressor for `stream`

pack-priv void cleanup(Http2Stream stream, EmbeddedChannel compressor)

Release remaining content from EmbeddedChannel and remove the compressor from the Http2Stream.

Parameters

stream:Http2Stream: The stream for which compressor is the compressor for
compressor:EmbeddedChannel: The compressor for stream

defaultCompressionOptions	back to summary
private static CompressionOptions[] defaultCompressionOptions()

getTargetContentEncoding back to summary

getTargetContentEncoding	back to summary
protected CharSequence getTargetContentEncoding(CharSequence contentEncoding) throws Http2Exception Returns the expected content encoding of the decoded content. Returning `contentEncoding` is the default behavior, which is the case for most compressors. Parameters contentEncoding:CharSequence the value of the `content-encoding` header Returns:CharSequence the expected content encoding of the new content. Exceptions Http2Exception: if the `contentEncoding` is not supported and warrants an exception

protected CharSequence getTargetContentEncoding(CharSequence contentEncoding) throws Http2Exception

Returns the expected content encoding of the decoded content. Returning contentEncoding is the default behavior, which is the case for most compressors.

Parameters

contentEncoding:CharSequence: the value of the content-encoding header

Returns:CharSequence

the expected content encoding of the new content.

Exceptions

Http2Exception:: if the contentEncoding is not supported and warrants an exception

newCompressionChannel back to summary

newCompressionChannel	back to summary
private EmbeddedChannel newCompressionChannel(final ChannelHandlerContext ctx, ZlibWrapper wrapper) Generate a new instance of an `EmbeddedChannel` capable of compressing data Parameters ctx:ChannelHandlerContext the context. wrapper:ZlibWrapper Defines what type of encoder should be used

private EmbeddedChannel newCompressionChannel(final ChannelHandlerContext ctx, ZlibWrapper wrapper)

Generate a new instance of an EmbeddedChannel capable of compressing data

Parameters

ctx:ChannelHandlerContext: the context.
wrapper:ZlibWrapper: Defines what type of encoder should be used

newCompressor back to summary

newCompressor	back to summary
private EmbeddedChannel newCompressor(ChannelHandlerContext ctx, Http2Headers headers, boolean endOfStream) throws Http2Exception Checks if a new compressor object is needed for the stream identified by `streamId`. This method will modify the `content-encoding` header contained in `headers`. Parameters ctx:ChannelHandlerContext the context. headers:Http2Headers Object representing headers which are to be written endOfStream:boolean Indicates if the stream has ended Returns:EmbeddedChannel The channel used to compress data. Exceptions Http2Exception: if any problems occur during initialization.

private EmbeddedChannel newCompressor(ChannelHandlerContext ctx, Http2Headers headers, boolean endOfStream) throws Http2Exception

Checks if a new compressor object is needed for the stream identified by streamId. This method will modify the content-encoding header contained in headers.

Parameters

ctx:ChannelHandlerContext: the context.
headers:Http2Headers: Object representing headers which are to be written
endOfStream:boolean: Indicates if the stream has ended

Returns:EmbeddedChannel

The channel used to compress data.

Exceptions

Http2Exception:: if any problems occur during initialization.

newContentCompressor back to summary

newContentCompressor	back to summary
protected EmbeddedChannel newContentCompressor(ChannelHandlerContext ctx, CharSequence contentEncoding) throws Http2Exception Returns a new `EmbeddedChannel` that encodes the HTTP2 message content encoded in the specified `contentEncoding`. Parameters ctx:ChannelHandlerContext the context. contentEncoding:CharSequence the value of the `content-encoding` header Returns:EmbeddedChannel a new `ByteToMessageDecoder` if the specified encoding is supported. `null` otherwise (alternatively, you can throw a `Http2Exception` to block unknown encoding). Exceptions Http2Exception: If the specified encoding is not supported and warrants an exception

protected EmbeddedChannel newContentCompressor(ChannelHandlerContext ctx, CharSequence contentEncoding) throws Http2Exception

Returns a new EmbeddedChannel that encodes the HTTP2 message content encoded in the specified contentEncoding.

Parameters

ctx:ChannelHandlerContext: the context.
contentEncoding:CharSequence: the value of the content-encoding header

Returns:EmbeddedChannel

a new ByteToMessageDecoder if the specified encoding is supported. null otherwise (alternatively, you can throw a Http2Exception to block unknown encoding).

Exceptions

Http2Exception:: If the specified encoding is not supported and warrants an exception

nextReadableBuf back to summary

nextReadableBuf	back to summary
private static ByteBuf nextReadableBuf(EmbeddedChannel compressor) Read the next compressed `ByteBuf` from the `EmbeddedChannel` or `null` if one does not exist. Parameters compressor:EmbeddedChannel The channel to read from Returns:ByteBuf The next decoded `ByteBuf` from the `EmbeddedChannel` or `null` if one does not exist

private static ByteBuf nextReadableBuf(EmbeddedChannel compressor)

Read the next compressed ByteBuf from the EmbeddedChannel or null if one does not exist.

Parameters

compressor:EmbeddedChannel: The channel to read from

Returns:ByteBuf

The next decoded ByteBuf from the EmbeddedChannel or null if one does not exist

writeData back to summary

writeData	back to summary
public ChannelFuture writeData(final ChannelHandlerContext ctx, final int streamId, ByteBuf data, int padding, final boolean endOfStream, ChannelPromise promise) Overrides io.netty.handler.codec.http2.DecoratingHttp2FrameWriter.writeData. Implements io.netty.handler.codec.http2.Http2DataWriter.writeData. Doc from io.netty.handler.codec.http2.Http2DataWriter.writeData. Writes a `DATA` frame to the remote endpoint. This will result in one or more frames being written to the context. Parameters ctx:ChannelHandlerContext the context to use for writing. streamId:int the stream for which to send the frame. data:ByteBuf the payload of the frame. This will be released by this method. padding:int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). A 1 byte padding is encoded as just the pad length field with value 0. A 256 byte padding is encoded as the pad length field with value 255 and 255 padding bytes appended to the end of the frame. endOfStream:boolean indicates if this is the last frame to be sent for the stream. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write. Annotations @Override

public ChannelFuture writeData(final ChannelHandlerContext ctx, final int streamId, ByteBuf data, int padding, final boolean endOfStream, ChannelPromise promise)

Overrides io.netty.handler.codec.http2.DecoratingHttp2FrameWriter.writeData.

Implements io.netty.handler.codec.http2.Http2DataWriter.writeData.

Doc from io.netty.handler.codec.http2.Http2DataWriter.writeData.

Writes a DATA frame to the remote endpoint. This will result in one or more frames being written to the context.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
streamId:int: the stream for which to send the frame.
data:ByteBuf: the payload of the frame. This will be released by this method.
padding:int: additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). A 1 byte padding is encoded as just the pad length field with value 0. A 256 byte padding is encoded as the pad length field with value 255 and 255 padding bytes appended to the end of the frame.
endOfStream:boolean: indicates if this is the last frame to be sent for the stream.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write.

Annotations

@Override

writeHeaders	back to summary
public ChannelFuture writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream, ChannelPromise promise) Overrides io.netty.handler.codec.http2.DecoratingHttp2FrameWriter.writeHeaders. Implements io.netty.handler.codec.http2.Http2FrameWriter.writeHeaders. Doc from io.netty.handler.codec.http2.Http2FrameWriter.writeHeaders. Writes a HEADERS frame to the remote endpoint. Parameters ctx:ChannelHandlerContext the context to use for writing. streamId:int the stream for which to send the frame. headers:Http2Headers the headers to be sent. padding:int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). endStream:boolean indicates if this is the last frame to be sent for the stream. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write. Section 10.5.1 states the following: The header block MUST be processed to ensure a consistent connection state, unless the connection is closed. If this call has modified the HPACK header state you MUST throw a connection error. If this call has NOT modified the HPACK header state you are free to throw a stream error. Annotations @Override

writeHeaders

back to summary

public ChannelFuture writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream, ChannelPromise promise)

Overrides io.netty.handler.codec.http2.DecoratingHttp2FrameWriter.writeHeaders.

Implements io.netty.handler.codec.http2.Http2FrameWriter.writeHeaders.

Doc from io.netty.handler.codec.http2.Http2FrameWriter.writeHeaders.

Writes a HEADERS frame to the remote endpoint.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
streamId:int: the stream for which to send the frame.
headers:Http2Headers: the headers to be sent.
padding:int: additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
endStream:boolean: indicates if this is the last frame to be sent for the stream.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write. Section 10.5.1 states the following:

The header block MUST be processed to ensure a consistent connection state, unless the connection is closed.

If this call has modified the HPACK header state you MUST throw a connection error.

If this call has NOT modified the HPACK header state you are free to throw a stream error.

Annotations

@Override

writeHeaders	back to summary
public ChannelFuture writeHeaders(final ChannelHandlerContext ctx, final int streamId, final Http2Headers headers, final int streamDependency, final short weight, final boolean exclusive, final int padding, final boolean endOfStream, final ChannelPromise promise) Overrides io.netty.handler.codec.http2.DecoratingHttp2FrameWriter.writeHeaders. Implements io.netty.handler.codec.http2.Http2FrameWriter.writeHeaders. Doc from io.netty.handler.codec.http2.Http2FrameWriter.writeHeaders. Writes a HEADERS frame with priority specified to the remote endpoint. Parameters ctx:ChannelHandlerContext the context to use for writing. streamId:int the stream for which to send the frame. headers:Http2Headers the headers to be sent. streamDependency:int the stream on which this stream should depend, or 0 if it should depend on the connection. weight:short the weight for this stream. exclusive:boolean whether this stream should be the exclusive dependant of its parent. padding:int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). endOfStream:boolean indicates if this is the last frame to be sent for the stream. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write. Section 10.5.1 states the following: The header block MUST be processed to ensure a consistent connection state, unless the connection is closed. If this call has modified the HPACK header state you MUST throw a connection error. If this call has NOT modified the HPACK header state you are free to throw a stream error. Annotations @Override

writeHeaders

back to summary

public ChannelFuture writeHeaders(final ChannelHandlerContext ctx, final int streamId, final Http2Headers headers, final int streamDependency, final short weight, final boolean exclusive, final int padding, final boolean endOfStream, final ChannelPromise promise)

Overrides io.netty.handler.codec.http2.DecoratingHttp2FrameWriter.writeHeaders.

Implements io.netty.handler.codec.http2.Http2FrameWriter.writeHeaders.

Doc from io.netty.handler.codec.http2.Http2FrameWriter.writeHeaders.

Writes a HEADERS frame with priority specified to the remote endpoint.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
streamId:int: the stream for which to send the frame.
headers:Http2Headers: the headers to be sent.
streamDependency:int: the stream on which this stream should depend, or 0 if it should depend on the connection.
weight:short: the weight for this stream.
exclusive:boolean: whether this stream should be the exclusive dependant of its parent.
padding:int: additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
endOfStream:boolean: indicates if this is the last frame to be sent for the stream.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write. Section 10.5.1 states the following:

The header block MUST be processed to ensure a consistent connection state, unless the connection is closed.

If this call has modified the HPACK header state you MUST throw a connection error.

If this call has NOT modified the HPACK header state you are free to throw a stream error.

Annotations

@Override

public Class CompressorHttp2ConnectionEncoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail