Module io.helidon.http.http2

Package io.helidon.http.http2

Enum Class Http2StreamState

java.lang.Object

java.lang.Enum<Http2StreamState>

io.helidon.http.http2.Http2StreamState

All Implemented Interfaces:

Serializable, Comparable<Http2StreamState>, Constable

public enum Http2StreamState
extends Enum<Http2StreamState>

Stream state. See https://datatracker.ietf.org/doc/html/rfc7540#section-5.1

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSED	Closed stream.
HALF_CLOSED_LOCAL	Local stream is closed, remote stream is open.
HALF_CLOSED_REMOTE	Remote stream is closed, local stream is open.
IDLE	The initial state of a stream.
OPEN	Both local and remote streams are open.
RESERVED_LOCAL	Push promise sent (not supported by Helidon).
RESERVED_REMOTE	Push promise received (not supported by Helidon).

Method Summary

Modifier and Type	Method	Description
static Http2StreamState	checkAndGetState(Http2StreamState current, Http2FrameType frameType, boolean send, boolean endOfStream, boolean endOfHeaders)	Check that the frame is ok for current state.
static Http2StreamState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Http2StreamState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IDLE

public static final Http2StreamState IDLE

The initial state of a stream.

Transitions to this state: none

Transitions from this state:

• send Http2FrameType.PUSH_PROMISE -> RESERVED_LOCAL
• recv Http2FrameType.PUSH_PROMISE -> RESERVED_REMOTE

RESERVED_LOCAL

public static final Http2StreamState RESERVED_LOCAL

Push promise sent (not supported by Helidon).

Transitions to this state:

• IDLE -> send Http2FrameType.PUSH_PROMISE

Transitions from this state:

• send Http2FrameType.HEADERS -> HALF_CLOSED_REMOTE
• send Http2FrameType.RST_STREAM -> CLOSED
• recv Http2FrameType.RST_STREAM -> CLOSED

RESERVED_REMOTE

public static final Http2StreamState RESERVED_REMOTE

Push promise received (not supported by Helidon).

Transitions to this state:

• IDLE -> recv Http2FrameType.PUSH_PROMISE

Transitions from this state:

• recv Http2FrameType.HEADERS -> HALF_CLOSED_LOCAL
• recv Http2FrameType.RST_STREAM -> CLOSED
• send Http2FrameType.RST_STREAM -> CLOSED

OPEN

public static final Http2StreamState OPEN

Both local and remote streams are open.

Transitions to this state:

• IDLE -> send Http2FrameType.HEADERS
• IDLE -> recv Http2FrameType.HEADERS

Transitions from this state (end of stream may be part of Http2FrameType.HEADERS or Http2FrameType.DATA):

• send Http2Flag.END_OF_STREAM -> HALF_CLOSED_LOCAL
• recv Http2Flag.END_OF_STREAM -> HALF_CLOSED_REMOTE
• send Http2FrameType.RST_STREAM -> CLOSED
• recv Http2FrameType.RST_STREAM -> CLOSED

HALF_CLOSED_LOCAL

public static final Http2StreamState HALF_CLOSED_LOCAL

Local stream is closed, remote stream is open.

Transitions to this state:

• RESERVED_REMOTE -> recv Http2FrameType.HEADERS
• OPEN -> send Http2Flag.END_OF_STREAM

Transitions from this state:

• recv Http2Flag.END_OF_STREAM -> CLOSED
• send Http2FrameType.RST_STREAM -> CLOSED
• recv Http2FrameType.RST_STREAM -> CLOSED

HALF_CLOSED_REMOTE

public static final Http2StreamState HALF_CLOSED_REMOTE

Remote stream is closed, local stream is open.

Transitions to this state:

• RESERVED_LOCAL -> send Http2FrameType.HEADERS
• OPEN -> recv Http2Flag.END_OF_STREAM

Transitions from this state:

• send Http2Flag.END_OF_STREAM -> CLOSED
• send Http2FrameType.RST_STREAM -> CLOSED
• recv Http2FrameType.RST_STREAM -> CLOSED

CLOSED

public static final Http2StreamState CLOSED

Closed stream. Transitions to this state:

• HALF_CLOSED_REMOTE -> by sending "END_STREAM", sending or receiving Http2FrameType.RST_STREAM
• HALF_CLOSED_LOCAL -> by receiving "END_STREAM", sending or receiving Http2FrameType.RST_STREAM
• OPEN, RESERVED_LOCAL, or RESERVED_REMOTE - by sending or receiving Http2FrameType.RST_STREAM

Transitions from this state: none

Method Details

values

public static Http2StreamState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Http2StreamState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

checkAndGetState

public static Http2StreamState checkAndGetState(Http2StreamState current,
 Http2FrameType frameType,
 boolean send,
 boolean endOfStream,
 boolean endOfHeaders)

Check that the frame is ok for current state.

Parameters:

current - current stream state

frameType - frame type

send - send

endOfStream - whether end of stream

endOfHeaders - whether end of headers

Returns:

stream state