- All Implemented Interfaces:
Serializable
,Comparable<ConnectionStatus>
,Constable
An enumeration of the various status values for a connection.
This describes the status of an object that attempts to maintain a persistent connection.
- Since:
- 200.1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionThe connection is open.A connection with the remote endpoint has been initiated but is not yet complete.The connection is not open.The connection has failed. -
Method Summary
Modifier and TypeMethodDescriptionstatic ConnectionStatus
Returns the enum constant of this class with the specified name.static ConnectionStatus[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
DISCONNECTED
The connection is not open. This is the initial state of the connection.- Since:
- 200.1.0
-
CONNECTING
A connection with the remote endpoint has been initiated but is not yet complete.- Since:
- 200.0.0
-
CONNECTED
The connection is open. This is the initial state after the handshake has been completed.- Since:
- 200.0.0
-
FAILED
The connection has failed.- Since:
- 200.0.0
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-