Modifier and Type	Class and Description
pack-priv static class	Http2CodecUtil.SimpleChannelPromiseAggregator Provides the ability to associate the outcome of multiple `Promise` objects into a single `Promise` object.

Field Summary

Modifier and Type	Field and Description
public static final Supplier<Buffer>	CONNECTION_PREFACE_BUFFER
public static final int	CONNECTION_STREAM_ID
public static final int	CONTINUATION_FRAME_HEADER_LENGTH
public static final int	DATA_FRAME_HEADER_LENGTH
public static final long	DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT_MILLIS
public static final long	DEFAULT_HEADER_LIST_SIZE The initial value of this setting is unlimited.</q>
public static final int	DEFAULT_HEADER_TABLE_SIZE
public static final int	DEFAULT_MAX_FRAME_SIZE
public static final int	DEFAULT_MAX_QUEUED_CONTROL_FRAMES
pack-priv static final int	DEFAULT_MAX_RESERVED_STREAMS
pack-priv static final int	DEFAULT_MIN_ALLOCATION_CHUNK
public static final short	DEFAULT_PRIORITY_WEIGHT
public static final int	DEFAULT_WINDOW_SIZE
public static final int	FRAME_HEADER_LENGTH
public static final int	GO_AWAY_FRAME_HEADER_LENGTH
public static final int	HEADERS_FRAME_HEADER_LENGTH
public static final CharSequence	HTTP_UPGRADE_PROTOCOL_NAME
public static final CharSequence	HTTP_UPGRADE_SETTINGS_HEADER
public static final int	HTTP_UPGRADE_STREAM_ID
public static final int	INT_FIELD_LENGTH
public static final long	MAX_CONCURRENT_STREAMS
public static final int	MAX_FRAME_SIZE_LOWER_BOUND
public static final int	MAX_FRAME_SIZE_UPPER_BOUND
public static final long	MAX_HEADER_LIST_SIZE
public static final long	MAX_HEADER_TABLE_SIZE
public static final int	MAX_INITIAL_WINDOW_SIZE
public static final int	MAX_PADDING The maximum number of padding bytes.
private static final int	MAX_PADDING_LENGTH_LENGTH
public static final short	MAX_UNSIGNED_BYTE
public static final long	MAX_UNSIGNED_INT
public static final short	MAX_WEIGHT
public static final long	MIN_CONCURRENT_STREAMS
public static final long	MIN_HEADER_LIST_SIZE
public static final long	MIN_HEADER_TABLE_SIZE
public static final int	MIN_INITIAL_WINDOW_SIZE
public static final short	MIN_WEIGHT
public static final int	NUM_STANDARD_SETTINGS
public static final int	PING_FRAME_PAYLOAD_LENGTH
public static final int	PRIORITY_ENTRY_LENGTH
public static final int	PRIORITY_FRAME_LENGTH
public static final int	PUSH_PROMISE_FRAME_HEADER_LENGTH
public static final int	RST_STREAM_FRAME_LENGTH
public static final int	SETTING_ENTRY_LENGTH
public static final char	SETTINGS_ENABLE_PUSH
public static final char	SETTINGS_HEADER_TABLE_SIZE
public static final char	SETTINGS_INITIAL_WINDOW_SIZE
public static final char	SETTINGS_MAX_CONCURRENT_STREAMS
public static final char	SETTINGS_MAX_FRAME_SIZE
public static final char	SETTINGS_MAX_HEADER_LIST_SIZE
public static final int	SMALLEST_MAX_CONCURRENT_STREAMS The assumed minimum value for `SETTINGS_MAX_CONCURRENT_STREAMS` as recommended by the HTTP/2 spec.
public static final CharSequence	TLS_UPGRADE_PROTOCOL_NAME
public static final int	WINDOW_UPDATE_FRAME_LENGTH

Access	Constructor and Description
private	Http2CodecUtil()

Method Summary

Modifier and Type	Method and Description
public static long	Returns: the threshold in bytes which should trigger a `GO_AWAY` if a set of headers exceeds this amount. calculateMaxHeaderListSizeGoAway(long SETTINGS_MAX_HEADER_LIST_SIZE for the local endpoint. maxHeaderListSize) Calculate the threshold in bytes which should trigger a `GO_AWAY` if a set of headers exceeds this amount.
public static Buffer	connectionPrefaceBuffer() Returns a buffer containing the `CONNECTION_PREFACE_BUFFER`.
public static Http2Exception	getEmbeddedHttp2Exception(Throwable cause) Iteratively looks through the causality chain for the given exception and returns the first `Http2Exception` or `null` if none.
public static void	headerListSizeExceeded(int The stream ID that was being processed when the exceptional condition occurred. streamId, long The max allowed size for a list of headers in bytes which was exceeded. maxHeaderListSize, boolean `true` if the exception was encountered during decoder. `false` for encode. onDecode) Results in a RST_STREAM being sent for `streamId` due to violating SETTINGS_MAX_HEADER_LIST_SIZE.
public static void	headerListSizeExceeded(long The max allowed size for a list of headers in bytes which was exceeded. maxHeaderListSize) Results in a GO_AWAY being sent due to violating SETTINGS_MAX_HEADER_LIST_SIZE in an unrecoverable manner.
public static boolean	isMaxFrameSizeValid(int maxFrameSize) Indicates whether or not the given value for max frame size falls within the valid range.
public static boolean	isOutboundStream(boolean `true` if the endpoint is a server, `false` otherwise. server, int the stream identifier streamId) Returns `true` if the stream is an outbound stream.
public static boolean	isStreamIdValid(int streamId) Returns true if the `streamId` is a valid HTTP/2 stream identifier.
pack-priv static boolean	isStreamIdValid(int streamId, boolean server)
public static int	readUnsignedInt(Buffer buf) Reads a big-endian (31-bit) integer from the buffer.
public static int	streamableBytes(StreamByteDistributor.StreamState state) Calculate the amount of bytes that can be sent by `state`.
public static Buffer	toBuffer(ChannelHandlerContext ctx, Throwable cause) Creates a buffer containing the error message from the given exception.
public static void	verifyPadding(int padding)
public static void	writeFrameHeader(Buffer out, int payloadLength, byte type, Http2Flags flags, int streamId) Writes an HTTP/2 frame header to the output buffer.
pack-priv static void	writeFrameHeaderInternal(Buffer out, int payloadLength, byte type, Http2Flags flags, int streamId)

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

Field Detail

CONNECTION_PREFACE_BUFFER	back to summary
public static final Supplier<Buffer> CONNECTION_PREFACE_BUFFER

CONNECTION_STREAM_ID	back to summary
public static final int CONNECTION_STREAM_ID

CONTINUATION_FRAME_HEADER_LENGTH	back to summary
public static final int CONTINUATION_FRAME_HEADER_LENGTH

DATA_FRAME_HEADER_LENGTH	back to summary
public static final int DATA_FRAME_HEADER_LENGTH

DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT_MILLIS	back to summary
public static final long DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT_MILLIS

DEFAULT_HEADER_LIST_SIZE	back to summary
public static final long DEFAULT_HEADER_LIST_SIZE The initial value of this setting is unlimited. However in practice we don't want to allow our peers to use unlimited memory by default. So we take advantage of the For any given request, a lower limit than what is advertised MAY be enforced. loophole.

DEFAULT_HEADER_TABLE_SIZE	back to summary
public static final int DEFAULT_HEADER_TABLE_SIZE

DEFAULT_MAX_FRAME_SIZE	back to summary
public static final int DEFAULT_MAX_FRAME_SIZE

DEFAULT_MAX_QUEUED_CONTROL_FRAMES	back to summary
public static final int DEFAULT_MAX_QUEUED_CONTROL_FRAMES

DEFAULT_MAX_RESERVED_STREAMS	back to summary
pack-priv static final int DEFAULT_MAX_RESERVED_STREAMS

DEFAULT_MIN_ALLOCATION_CHUNK	back to summary
pack-priv static final int DEFAULT_MIN_ALLOCATION_CHUNK

DEFAULT_PRIORITY_WEIGHT	back to summary
public static final short DEFAULT_PRIORITY_WEIGHT

DEFAULT_WINDOW_SIZE	back to summary
public static final int DEFAULT_WINDOW_SIZE

FRAME_HEADER_LENGTH	back to summary
public static final int FRAME_HEADER_LENGTH

GO_AWAY_FRAME_HEADER_LENGTH	back to summary
public static final int GO_AWAY_FRAME_HEADER_LENGTH

HEADERS_FRAME_HEADER_LENGTH	back to summary
public static final int HEADERS_FRAME_HEADER_LENGTH

HTTP_UPGRADE_PROTOCOL_NAME	back to summary
public static final CharSequence HTTP_UPGRADE_PROTOCOL_NAME

HTTP_UPGRADE_SETTINGS_HEADER	back to summary
public static final CharSequence HTTP_UPGRADE_SETTINGS_HEADER

HTTP_UPGRADE_STREAM_ID	back to summary
public static final int HTTP_UPGRADE_STREAM_ID

INT_FIELD_LENGTH	back to summary
public static final int INT_FIELD_LENGTH

MAX_CONCURRENT_STREAMS	back to summary
public static final long MAX_CONCURRENT_STREAMS

MAX_FRAME_SIZE_LOWER_BOUND	back to summary
public static final int MAX_FRAME_SIZE_LOWER_BOUND

MAX_FRAME_SIZE_UPPER_BOUND	back to summary
public static final int MAX_FRAME_SIZE_UPPER_BOUND

MAX_HEADER_LIST_SIZE	back to summary
public static final long MAX_HEADER_LIST_SIZE

MAX_HEADER_TABLE_SIZE	back to summary
public static final long MAX_HEADER_TABLE_SIZE

MAX_INITIAL_WINDOW_SIZE	back to summary
public static final int MAX_INITIAL_WINDOW_SIZE

MAX_PADDING	back to summary
public static final int MAX_PADDING The maximum number of padding bytes. That is the 255 padding bytes appended to the end of a frame and the 1 byte pad length field.

MAX_PADDING_LENGTH_LENGTH	back to summary
private static final int MAX_PADDING_LENGTH_LENGTH

MAX_UNSIGNED_BYTE	back to summary
public static final short MAX_UNSIGNED_BYTE

MAX_UNSIGNED_INT	back to summary
public static final long MAX_UNSIGNED_INT

MAX_WEIGHT	back to summary
public static final short MAX_WEIGHT

MIN_CONCURRENT_STREAMS	back to summary
public static final long MIN_CONCURRENT_STREAMS

MIN_HEADER_LIST_SIZE	back to summary
public static final long MIN_HEADER_LIST_SIZE

MIN_HEADER_TABLE_SIZE	back to summary
public static final long MIN_HEADER_TABLE_SIZE

MIN_INITIAL_WINDOW_SIZE	back to summary
public static final int MIN_INITIAL_WINDOW_SIZE

MIN_WEIGHT	back to summary
public static final short MIN_WEIGHT

NUM_STANDARD_SETTINGS	back to summary
public static final int NUM_STANDARD_SETTINGS

PING_FRAME_PAYLOAD_LENGTH	back to summary
public static final int PING_FRAME_PAYLOAD_LENGTH

PRIORITY_ENTRY_LENGTH	back to summary
public static final int PRIORITY_ENTRY_LENGTH

PRIORITY_FRAME_LENGTH	back to summary
public static final int PRIORITY_FRAME_LENGTH

PUSH_PROMISE_FRAME_HEADER_LENGTH	back to summary
public static final int PUSH_PROMISE_FRAME_HEADER_LENGTH

RST_STREAM_FRAME_LENGTH	back to summary
public static final int RST_STREAM_FRAME_LENGTH

SETTING_ENTRY_LENGTH	back to summary
public static final int SETTING_ENTRY_LENGTH

SETTINGS_ENABLE_PUSH	back to summary
public static final char SETTINGS_ENABLE_PUSH

SETTINGS_HEADER_TABLE_SIZE	back to summary
public static final char SETTINGS_HEADER_TABLE_SIZE

SETTINGS_INITIAL_WINDOW_SIZE	back to summary
public static final char SETTINGS_INITIAL_WINDOW_SIZE

SETTINGS_MAX_CONCURRENT_STREAMS	back to summary
public static final char SETTINGS_MAX_CONCURRENT_STREAMS

SETTINGS_MAX_FRAME_SIZE	back to summary
public static final char SETTINGS_MAX_FRAME_SIZE

SETTINGS_MAX_HEADER_LIST_SIZE	back to summary
public static final char SETTINGS_MAX_HEADER_LIST_SIZE

SMALLEST_MAX_CONCURRENT_STREAMS	back to summary
public static final int SMALLEST_MAX_CONCURRENT_STREAMS The assumed minimum value for `SETTINGS_MAX_CONCURRENT_STREAMS` as recommended by the HTTP/2 spec.

TLS_UPGRADE_PROTOCOL_NAME	back to summary
public static final CharSequence TLS_UPGRADE_PROTOCOL_NAME

WINDOW_UPDATE_FRAME_LENGTH	back to summary
public static final int WINDOW_UPDATE_FRAME_LENGTH

Method Detail

calculateMaxHeaderListSizeGoAway back to summary

public static long calculateMaxHeaderListSizeGoAway(long maxHeaderListSize)

Calculate the threshold in bytes which should trigger a GO_AWAY if a set of headers exceeds this amount.

Parameters

maxHeaderListSize:long: SETTINGS_MAX_HEADER_LIST_SIZE for the local endpoint.

Returns:long

the threshold in bytes which should trigger a GO_AWAY if a set of headers exceeds this amount.

connectionPrefaceBuffer	back to summary
public static Buffer connectionPrefaceBuffer() Returns a buffer containing the `CONNECTION_PREFACE_BUFFER`.

getEmbeddedHttp2Exception	back to summary
public static Http2Exception getEmbeddedHttp2Exception(Throwable cause) Iteratively looks through the causality chain for the given exception and returns the first `Http2Exception` or `null` if none.

headerListSizeExceeded back to summary

public static void headerListSizeExceeded(int streamId, long maxHeaderListSize, boolean onDecode) throws Http2Exception

Results in a RST_STREAM being sent for streamId due to violating SETTINGS_MAX_HEADER_LIST_SIZE.

Parameters

streamId:int: The stream ID that was being processed when the exceptional condition occurred.
maxHeaderListSize:long: The max allowed size for a list of headers in bytes which was exceeded.
onDecode:boolean: true if the exception was encountered during decoder. false for encode.

Exceptions

Http2Exception:: a stream error.

headerListSizeExceeded

back to summary

public static void headerListSizeExceeded(long maxHeaderListSize) throws Http2Exception

Results in a GO_AWAY being sent due to violating SETTINGS_MAX_HEADER_LIST_SIZE in an unrecoverable manner.

Parameters

maxHeaderListSize:long: The max allowed size for a list of headers in bytes which was exceeded.

Exceptions

Http2Exception:: a connection error.

isMaxFrameSizeValid	back to summary
public static boolean isMaxFrameSizeValid(int maxFrameSize) Indicates whether or not the given value for max frame size falls within the valid range.

isOutboundStream back to summary

public static boolean isOutboundStream(boolean server, int streamId)

Returns true if the stream is an outbound stream.

Parameters

server:boolean: true if the endpoint is a server, false otherwise.
streamId:int: the stream identifier

isStreamIdValid	back to summary
public static boolean isStreamIdValid(int streamId) Returns true if the `streamId` is a valid HTTP/2 stream identifier.

isStreamIdValid	back to summary
pack-priv static boolean isStreamIdValid(int streamId, boolean server)

readUnsignedInt	back to summary
public static int readUnsignedInt(Buffer buf) Reads a big-endian (31-bit) integer from the buffer.

streamableBytes	back to summary
public static int streamableBytes(StreamByteDistributor.StreamState state) Calculate the amount of bytes that can be sent by `state`. The lower bound is `0`.

toBuffer	back to summary
public static Buffer toBuffer(ChannelHandlerContext ctx, Throwable cause) Creates a buffer containing the error message from the given exception. If the cause is `null` returns an empty buffer.

verifyPadding	back to summary
public static void verifyPadding(int padding)

writeFrameHeader	back to summary
public static void writeFrameHeader(Buffer out, int payloadLength, byte type, Http2Flags flags, int streamId) Writes an HTTP/2 frame header to the output buffer.

writeFrameHeaderInternal	back to summary
pack-priv static void writeFrameHeaderInternal(Buffer out, int payloadLength, byte type, Http2Flags flags, int streamId)

io.netty5.handler.codec.http2 back to summary

pack-priv final Class Http2CodecUtil.SimpleChannelPromiseAggregator

Class Inheritance

extends DefaultPromise<Void>

java.lang.Object
io.netty5.util.concurrent.DefaultPromise
io.netty5.handler.codec.http2.Http2CodecUtil.SimpleChannelPromiseAggregator

Provides the ability to associate the outcome of multiple Promise objects into a single Promise object.

Field Summary

Modifier and Type	Field and Description
private Throwable	aggregateFailure
private boolean	doneAllocating
private int	doneCount
private int	expectedCount
private final Promise<Void>	promise

Constructor Summary

Access	Constructor and Description
pack-priv	SimpleChannelPromiseAggregator(Promise<Void> promise, EventExecutor e)

Method Summary

Modifier and Type	Method and Description
private boolean	allowFailure()
private boolean	allPromisesDone()
private boolean	awaitingPromises()
public Future<Void>	Returns: The `Future` that is the aggregation of all promises allocated with `newPromise()`. doneAllocatingPromises() Signify that no more `newPromise()` allocations will be made.
public Promise<Void>	Returns: A new promise which will be aggregated. `null` if `doneAllocatingPromises()` was previously called. newPromise() Allocate a new promise which will be used to aggregate the overall success of this promise aggregator.
private void	setAggregateFailure(Throwable cause)
public Promise<Void>	setFailure(Throwable cause) Overrides io.netty5.util.concurrent.DefaultPromise.setFailure. Implements io.netty5.util.concurrent.Promise.setFailure. Fail this object if it has not already been failed.
private Promise<Void>	setPromise()
public Promise<Void>	setSuccess(Void result) Overrides io.netty5.util.concurrent.DefaultPromise.setSuccess. Implements io.netty5.util.concurrent.Promise.setSuccess. Marks this promise as a success and notifies all listeners attached to the future.
public boolean	tryFailure(Throwable cause) Overrides io.netty5.util.concurrent.DefaultPromise.tryFailure. Implements io.netty5.util.concurrent.Promise.tryFailure. Marks this promise as a failure and notifies all listeners.
private boolean	tryPromise()
public boolean	trySuccess(Void result) Overrides io.netty5.util.concurrent.DefaultPromise.trySuccess. Implements io.netty5.util.concurrent.Promise.trySuccess. Marks this future as a success and notifies all listeners.

Field Detail

aggregateFailure	back to summary
private Throwable aggregateFailure

doneAllocating	back to summary
private boolean doneAllocating

doneCount	back to summary
private int doneCount

expectedCount	back to summary
private int expectedCount

promise	back to summary
private final Promise<Void> promise

Constructor Detail

SimpleChannelPromiseAggregator	back to summary
pack-priv SimpleChannelPromiseAggregator(Promise<Void> promise, EventExecutor e)

Method Detail

allowFailure	back to summary
private boolean allowFailure()

allPromisesDone	back to summary
private boolean allPromisesDone()

awaitingPromises	back to summary
private boolean awaitingPromises()

doneAllocatingPromises back to summary

public Future<Void> doneAllocatingPromises()

Signify that no more newPromise() allocations will be made. The aggregation can not be successful until this method is called.

Returns:Future<Void>: The Future that is the aggregation of all promises allocated with newPromise().

newPromise back to summary

public Promise<Void> newPromise()

Allocate a new promise which will be used to aggregate the overall success of this promise aggregator.

Returns:Promise<Void>: A new promise which will be aggregated. null if doneAllocatingPromises() was previously called.

setAggregateFailure	back to summary
private void setAggregateFailure(Throwable cause)

setFailure back to summary

public Promise<Void> setFailure(Throwable cause)

Overrides io.netty5.util.concurrent.DefaultPromise.setFailure.

Implements io.netty5.util.concurrent.Promise.setFailure.

Fail this object if it has not already been failed.

This method will NOT throw an IllegalStateException if called multiple times because that may be expected.

Annotations

@Override

setPromise	back to summary
private Promise<Void> setPromise()

setSuccess back to summary

public Promise<Void> setSuccess(Void result)

Overrides io.netty5.util.concurrent.DefaultPromise.setSuccess.

Implements io.netty5.util.concurrent.Promise.setSuccess.

Doc from io.netty5.util.concurrent.Promise.setSuccess.

Marks this promise as a success and notifies all listeners attached to the future.

If it is success or failed already it will throw an IllegalStateException.

Annotations

@Override

tryFailure back to summary

public boolean tryFailure(Throwable cause)

Overrides io.netty5.util.concurrent.DefaultPromise.tryFailure.

Implements io.netty5.util.concurrent.Promise.tryFailure.

Doc from io.netty5.util.concurrent.Promise.tryFailure.

Marks this promise as a failure and notifies all listeners.

Returns:boolean

true if and only if successfully marked this promise as a failure. Otherwise false because this promise is already marked as either a success or a failure.

Annotations

@Override

tryPromise	back to summary
private boolean tryPromise()

trySuccess back to summary

public boolean trySuccess(Void result)

Overrides io.netty5.util.concurrent.DefaultPromise.trySuccess.

Implements io.netty5.util.concurrent.Promise.trySuccess.

Doc from io.netty5.util.concurrent.Promise.trySuccess.

Marks this future as a success and notifies all listeners.

Returns:boolean

true if and only if successfully marked this promise as a success. Otherwise false because this promise is already marked as either a success or a failure.

Annotations

@Override

public final Class Http2CodecUtil

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class Http2CodecUtil.SimpleChannelPromiseAggregator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail