Modifier and Type	Class and Description
public static enum	Http2Stream.State The allowed states of an HTTP2 stream.

Method Summary

Modifier and Type	Method and Description
public Http2Stream	close() Closes the stream.
public Http2Stream	closeLocalSide() Closes the local side of this stream.
public Http2Stream	closeRemoteSide() Closes the remote side of this stream.
public <V> V	getProperty(Http2Connection.PropertyKey key) Returns application-defined data if any was associated with this stream.
public Http2Stream	headersReceived(boolean `true` if the headers contain an informational status code (for responses only). isInformational) Indicates that headers have been received.
public Http2Stream	headersSent(boolean `true` if the headers contain an informational status code (for responses only). isInformational) Indicates that headers have been sent to the remote endpoint on this stream.
public int	id() Gets the unique identifier for this stream within the connection.
public boolean	isHeadersReceived() Indicates whether or not the initial headers have been received.
public boolean	isHeadersSent() Indicates whether or not headers were sent to the remote endpoint.
public boolean	isPushPromiseSent() Indicates whether or not a push promise was sent to the remote endpoint.
public boolean	isResetSent() Indicates whether a `RST_STREAM` frame has been sent from the local endpoint for this stream.
public boolean	isTrailersReceived() Indicates whether or not the trailers have been received.
public boolean	isTrailersSent() Indicates whether or not trailers were sent to the remote endpoint.
public Http2Stream	open(boolean halfClosed) Opens this stream, making it available via `Http2Connection#forEachActiveStream(Http2StreamVisitor)` and transition state to: `State#OPEN` if `state()` is `State#IDLE` and `halfClosed` is `false`. `State#HALF_CLOSED_LOCAL` if `state()` is `State#IDLE` and `halfClosed` is `true` and the stream is local. In this state, `isHeadersSent()` is `true` `State#HALF_CLOSED_REMOTE` if `state()` is `State#IDLE` and `halfClosed` is `true` and the stream is remote. In this state, `isHeadersReceived()` is `true` `State#RESERVED_LOCAL` if `state()` is `State#HALF_CLOSED_REMOTE`. `State#RESERVED_REMOTE` if `state()` is `State#HALF_CLOSED_LOCAL`.
public Http2Stream	pushPromiseSent() Indicates that a push promise was sent to the remote endpoint.
public <V> V	removeProperty(Http2Connection.PropertyKey key) Returns and removes application-defined data if any was associated with this stream.
public Http2Stream	resetSent() Sets the flag indicating that a `RST_STREAM` frame has been sent from the local endpoint for this stream.
public <V> V	Returns: The value that was previously associated with `key`, or `null` if there was none. setProperty(Http2Connection.PropertyKey key, V value) Associates the application-defined data with this stream.
public Http2Stream.State	state() Gets the state of this stream.

Method Detail

close	back to summary
public Http2Stream close() Closes the stream.

closeLocalSide	back to summary
public Http2Stream closeLocalSide() Closes the local side of this stream. If this makes the stream closed, the child is closed as well.

closeRemoteSide	back to summary
public Http2Stream closeRemoteSide() Closes the remote side of this stream. If this makes the stream closed, the child is closed as well.

getProperty	back to summary
public <V> V getProperty(Http2Connection.PropertyKey key) Returns application-defined data if any was associated with this stream.

headersReceived back to summary

headersReceived	back to summary
public Http2Stream headersReceived(boolean isInformational) Indicates that headers have been received. The first call to this method would be for the initial headers (see `isHeadersReceived()`} and the second call would indicate the trailers (see `isTrailersReceived()`). Parameters isInformational:boolean `true` if the headers contain an informational status code (for responses only).

public Http2Stream headersReceived(boolean isInformational)

Indicates that headers have been received. The first call to this method would be for the initial headers (see isHeadersReceived()} and the second call would indicate the trailers (see isTrailersReceived()).

Parameters

isInformational:boolean: true if the headers contain an informational status code (for responses only).

headersSent back to summary

headersSent	back to summary
public Http2Stream headersSent(boolean isInformational) Indicates that headers have been sent to the remote endpoint on this stream. The first call to this method would be for the initial headers (see `isHeadersSent()`} and the second call would indicate the trailers (see `isTrailersReceived()`). Parameters isInformational:boolean `true` if the headers contain an informational status code (for responses only).

public Http2Stream headersSent(boolean isInformational)

Indicates that headers have been sent to the remote endpoint on this stream. The first call to this method would be for the initial headers (see isHeadersSent()} and the second call would indicate the trailers (see isTrailersReceived()).

Parameters

isInformational:boolean: true if the headers contain an informational status code (for responses only).

id	back to summary
public int id() Gets the unique identifier for this stream within the connection.

isHeadersReceived	back to summary
public boolean isHeadersReceived() Indicates whether or not the initial headers have been received.

isHeadersSent	back to summary
public boolean isHeadersSent() Indicates whether or not headers were sent to the remote endpoint.

isPushPromiseSent	back to summary
public boolean isPushPromiseSent() Indicates whether or not a push promise was sent to the remote endpoint.

isResetSent	back to summary
public boolean isResetSent() Indicates whether a `RST_STREAM` frame has been sent from the local endpoint for this stream.

isTrailersReceived	back to summary
public boolean isTrailersReceived() Indicates whether or not the trailers have been received.

isTrailersSent	back to summary
public boolean isTrailersSent() Indicates whether or not trailers were sent to the remote endpoint.

open back to summary

open	back to summary
public Http2Stream open(boolean halfClosed) throws Http2Exception Opens this stream, making it available via `Http2Connection#forEachActiveStream(Http2StreamVisitor)` and transition state to: `State#OPEN` if `state()` is `State#IDLE` and `halfClosed` is `false`. `State#HALF_CLOSED_LOCAL` if `state()` is `State#IDLE` and `halfClosed` is `true` and the stream is local. In this state, `isHeadersSent()` is `true` `State#HALF_CLOSED_REMOTE` if `state()` is `State#IDLE` and `halfClosed` is `true` and the stream is remote. In this state, `isHeadersReceived()` is `true` `State#RESERVED_LOCAL` if `state()` is `State#HALF_CLOSED_REMOTE`. `State#RESERVED_REMOTE` if `state()` is `State#HALF_CLOSED_LOCAL`.

public Http2Stream open(boolean halfClosed) throws Http2Exception

Opens this stream, making it available via Http2Connection#forEachActiveStream(Http2StreamVisitor) and transition state to:

State#OPEN if state() is State#IDLE and halfClosed is false.
State#HALF_CLOSED_LOCAL if state() is State#IDLE and halfClosed is true and the stream is local. In this state, isHeadersSent() is true
State#HALF_CLOSED_REMOTE if state() is State#IDLE and halfClosed is true and the stream is remote. In this state, isHeadersReceived() is true
State#RESERVED_LOCAL if state() is State#HALF_CLOSED_REMOTE.
State#RESERVED_REMOTE if state() is State#HALF_CLOSED_LOCAL.

pushPromiseSent	back to summary
public Http2Stream pushPromiseSent() Indicates that a push promise was sent to the remote endpoint.

removeProperty	back to summary
public <V> V removeProperty(Http2Connection.PropertyKey key) Returns and removes application-defined data if any was associated with this stream.

resetSent	back to summary
public Http2Stream resetSent() Sets the flag indicating that a `RST_STREAM` frame has been sent from the local endpoint for this stream. This does not affect the stream state.

setProperty back to summary

setProperty	back to summary
public <V> V setProperty(Http2Connection.PropertyKey key, V value) Associates the application-defined data with this stream. Returns:V The value that was previously associated with `key`, or `null` if there was none.

public <V> V setProperty(Http2Connection.PropertyKey key, V value)

Associates the application-defined data with this stream.

Returns:V: The value that was previously associated with key, or null if there was none.

state	back to summary
public Http2Stream.State state() Gets the state of this stream.

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

public final Enum Http2Stream.State

Class Inheritance

extends Enum<Http2Stream.State>

java.lang.Object
java.lang.Enum
io.netty5.handler.codec.http2.Http2Stream.State

The allowed states of an HTTP2 stream.

Field Summary

Modifier and Type	Field and Description
public static final Http2Stream.State	CLOSED
public static final Http2Stream.State	HALF_CLOSED_LOCAL
public static final Http2Stream.State	HALF_CLOSED_REMOTE
public static final Http2Stream.State	IDLE
private final boolean	localSideOpen
public static final Http2Stream.State	OPEN
private final boolean	remoteSideOpen
public static final Http2Stream.State	RESERVED_LOCAL
public static final Http2Stream.State	RESERVED_REMOTE

Constructor Summary

Access	Constructor and Description
private	State(boolean localSideOpen, boolean remoteSideOpen)

Method Summary

Modifier and Type	Method and Description
public boolean	localSideOpen() Indicates whether the local side of this stream is open (i.e. the state is either `State#OPEN` or `State#HALF_CLOSED_REMOTE`).
public boolean	remoteSideOpen() Indicates whether the remote side of this stream is open (i.e. the state is either `State#OPEN` or `State#HALF_CLOSED_LOCAL`).
public static Http2Stream.State	valueOf(String name)
public static Http2Stream.State[]	values()

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

Field Detail

CLOSED	back to summary
public static final Http2Stream.State CLOSED

HALF_CLOSED_LOCAL	back to summary
public static final Http2Stream.State HALF_CLOSED_LOCAL

HALF_CLOSED_REMOTE	back to summary
public static final Http2Stream.State HALF_CLOSED_REMOTE

IDLE	back to summary
public static final Http2Stream.State IDLE

localSideOpen	back to summary
private final boolean localSideOpen

OPEN	back to summary
public static final Http2Stream.State OPEN

remoteSideOpen	back to summary
private final boolean remoteSideOpen

RESERVED_LOCAL	back to summary
public static final Http2Stream.State RESERVED_LOCAL

RESERVED_REMOTE	back to summary
public static final Http2Stream.State RESERVED_REMOTE

Constructor Detail

State	back to summary
private State(boolean localSideOpen, boolean remoteSideOpen)

Method Detail

localSideOpen	back to summary
public boolean localSideOpen() Indicates whether the local side of this stream is open (i.e. the state is either `State#OPEN` or `State#HALF_CLOSED_REMOTE`).

remoteSideOpen	back to summary
public boolean remoteSideOpen() Indicates whether the remote side of this stream is open (i.e. the state is either `State#OPEN` or `State#HALF_CLOSED_LOCAL`).

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

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

public Interface Http2Stream

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum Http2Stream.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail