net.scattersphere.api

Enum ClientConnectionState

java.lang.Object

java.lang.Enum<ClientConnectionState>

net.scattersphere.api.ClientConnectionState

All Implemented Interfaces:

Serializable, Comparable<ClientConnectionState>

public enum ClientConnectionState
extends Enum<ClientConnectionState>

These are the client connection states that occur during a connection. These states are sent in the ClientConnection class, and are used to indicate whether a client is waiting to connect, has connected, has dropped, or has failed. Created by kenji on 1/4/15.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED Endpoint has closed the connection, or the connection has dropped.
CONNECTED Endpoint connected.
FAILED The connection failed due to a network issue.
WAITING Waiting for connection, or attempting to connect.

Method Summary

Modifier and Type	Method and Description
static ClientConnectionState	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClientConnectionState[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WAITING

public static final ClientConnectionState WAITING

Waiting for connection, or attempting to connect.

CONNECTED

public static final ClientConnectionState CONNECTED

Endpoint connected.

CLOSED

public static final ClientConnectionState CLOSED

Endpoint has closed the connection, or the connection has dropped.

FAILED

public static final ClientConnectionState FAILED

The connection failed due to a network issue.

Method Detail

values

public static ClientConnectionState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClientConnectionState c : ClientConnectionState.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClientConnectionState 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