Enum ConnectionState.State
- All Implemented Interfaces:
Serializable
,Comparable<ConnectionState.State>
- Enclosing class:
ConnectionState
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe WebSocket is closingThe WebSocket connection is disconnected.Initial state of a connection, the upgrade request / response handshake is in progressThe websocket connection is established and open.Intermediate state between HANDSHAKING and OPENED, used to indicate that a upgrade request/response handshake is successful, but the Application provided socket's onOpen code has yet completed. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ConnectionState.State
Returns the enum constant of this type with the specified name.static ConnectionState.State[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
HANDSHAKING
Initial state of a connection, the upgrade request / response handshake is in progress -
OPENING
Intermediate state between HANDSHAKING and OPENED, used to indicate that a upgrade request/response handshake is successful, but the Application provided socket's onOpen code has yet completed.This state is to allow the local socket endpoint to initiate the sending of messages and frames, but to NOT start reading yet.
-
OPENED
The websocket connection is established and open.This indicates that the Upgrade has succeed, and the Application provided socket's onOpen code has returned.
It is now time to start reading from the remote endpoint.
-
CLOSING
The WebSocket is closingThere are several conditions that would start this state.
- A CLOSE Frame has been received (and parsed) from the remote endpoint - A CLOSE Frame has been enqueued by the local endpoint
-
DISCONNECTED
The WebSocket connection is disconnected.Connection is complete and no longer valid.
-
-
Constructor Details
-
State
private State()
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-