Package io.github.mahmoudimus.quic.connection

Enum Class RecvState

java.lang.Object

java.lang.Enum<RecvState>

io.github.mahmoudimus.quic.connection.RecvState

All Implemented Interfaces:

Serializable, Comparable<RecvState>, Constable

public enum RecvState
extends Enum<RecvState>

The states of the receiving part of a stream (RFC 9000 section 3.2, figure 3).

   RECV --STREAM with FIN--> SIZE_KNOWN --all data received--> DATA_RECVD --app read all--> DATA_READ
     |                          |                                |
     +-------- RESET_STREAM ----+--------------------------------+--> RESET_RECVD --app read reset--> RESET_READ
 

The terminal states DATA_READ and RESET_READ are reached when the application has seen the end of the stream or its reset: StreamsState then forgets the stream.

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
DATA_READ	The application has read all the data.
DATA_RECVD	Every byte up to the final size has arrived.
RECV	Receiving data; the final size is unknown.
RESET_READ	The application has seen the reset.
RESET_RECVD	The peer reset the stream.
SIZE_KNOWN	A frame with the FIN bit fixed the final size; some data is still missing.

Method Summary

Modifier and Type	Method	Description
static RecvState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RecvState[]	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

RECV

public static final RecvState RECV

Receiving data; the final size is unknown.

SIZE_KNOWN

public static final RecvState SIZE_KNOWN

A frame with the FIN bit fixed the final size; some data is still missing.

DATA_RECVD

public static final RecvState DATA_RECVD

Every byte up to the final size has arrived.

DATA_READ

public static final RecvState DATA_READ

The application has read all the data.

RESET_RECVD

public static final RecvState RESET_RECVD

The peer reset the stream.

RESET_READ

public static final RecvState RESET_READ

The application has seen the reset.

Method Details

values

public static RecvState[] 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 RecvState 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