Enum WebSocketState
- All Implemented Interfaces:
Comparable<WebSocketState>
Lifecycle state of a
WebSocket. The ordinal values match the browser
WebSocket spec and java.net.http.WebSocket so platform implementations
can map their native state directly.-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe connection is fully closed and cannot be reopened.A close has been initiated (locally or by the peer); the connection is draining final frames.The connection is being negotiated.The handshake completed and the connection is live. -
Method Summary
Modifier and TypeMethodDescriptionstatic WebSocketStateReturns the enum constant of this type with the specified name.static WebSocketState[]values()Returns an array containing the constants of this enum type, in the order they are declared.Methods inherited from class Enum
clone, compareTo, equals, getDeclaringClass, getEnumValues, hashCode, name, ordinal, setEnumValues, toString, valueOf
-
Enum Constant Details
-
CONNECTING
The connection is being negotiated. Sending messages in this state throwsIllegalStateException. -
OPEN
The handshake completed and the connection is live. Messages can flow in both directions. -
CLOSING
A close has been initiated (locally or by the peer); the connection is draining final frames. -
CLOSED
The connection is fully closed and cannot be reopened. Build a newWebSocketto reconnect.
-
-
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
-