Package org.eclipse.jetty.http2

Enum CloseState

java.lang.Object

java.lang.Enum<CloseState>

org.eclipse.jetty.http2.CloseState

All Implemented Interfaces:

Serializable, Comparable<CloseState>, java.lang.constant.Constable

public enum CloseState
extends Enum<CloseState>

The set of close states for a stream or a session.

                rcv hc
 NOT_CLOSED ---------------> REMOTELY_CLOSED
      |                             |
   gen|                             |gen
    hc|                             |hc
      |                             |
      v              rcv hc         v
 LOCALLY_CLOSING --------------> CLOSING
      |                             |
   snd|                             |gen
    hc|                             |hc
      |                             |
      v              rcv hc         v
 LOCALLY_CLOSED ----------------> CLOSED
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CloseState.Event

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSED	Fully closed.
CLOSING	A half-close frame has been received and a half-close frame has been generated, but not yet sent.
LOCALLY_CLOSED	A half-close frame has been generated and sent.
LOCALLY_CLOSING	A half-close frame has been generated.
NOT_CLOSED	Fully open.
REMOTELY_CLOSED	A half-close frame has been received.

Method Summary

Modifier and Type	Method	Description
static CloseState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CloseState[]	values()	Returns an array containing the constants of this enum type, 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

NOT_CLOSED

public static final CloseState NOT_CLOSED

Fully open.

LOCALLY_CLOSING

public static final CloseState LOCALLY_CLOSING

A half-close frame has been generated.

LOCALLY_CLOSED

public static final CloseState LOCALLY_CLOSED

A half-close frame has been generated and sent.

REMOTELY_CLOSED

public static final CloseState REMOTELY_CLOSED

A half-close frame has been received.

CLOSING

public static final CloseState CLOSING

A half-close frame has been received and a half-close frame has been generated, but not yet sent.

CLOSED

public static final CloseState CLOSED

Fully closed.

Method Details

values

public static CloseState[] values()

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

Returns:

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

valueOf

public static CloseState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null