Package dev.objz.commandbridge.api.platform

Enum Class ConnectionState

java.lang.Object

java.lang.Enum<ConnectionState>

dev.objz.commandbridge.api.platform.ConnectionState

All Implemented Interfaces:

Serializable, Comparable<ConnectionState>, Constable

public enum ConnectionState
extends Enum<ConnectionState>

Represents the network connection status between a server and the bridge.

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
AUTH_FAILED	Authentication failed; no further attempts will be made.
AUTHENTICATED	Fully connected and authorized to send/receive messages.
CONNECTED	Socket connected, awaiting authentication.
CONNECTING	Attempting to establish a socket connection.
DISCONNECTED	No connection established.
RECONNECTING	Connection lost, attempting to re-establish.

Method Summary

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

DISCONNECTED

public static final ConnectionState DISCONNECTED

No connection established.

CONNECTING

public static final ConnectionState CONNECTING

Attempting to establish a socket connection.

CONNECTED

public static final ConnectionState CONNECTED

Socket connected, awaiting authentication.

AUTHENTICATED

public static final ConnectionState AUTHENTICATED

Fully connected and authorized to send/receive messages.

RECONNECTING

public static final ConnectionState RECONNECTING

Connection lost, attempting to re-establish.

AUTH_FAILED

public static final ConnectionState AUTH_FAILED

Authentication failed; no further attempts will be made.

Method Details

values

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

isActive

public boolean isActive()

Returns:

true if the connection is established and ready for message transport