Package com.zeroc.Ice.Instrumentation

Enum Class ConnectionState

java.lang.Object

java.lang.Enum<ConnectionState>

com.zeroc.Ice.Instrumentation.ConnectionState

All Implemented Interfaces:

Serializable, Comparable<ConnectionState>, Constable

public enum ConnectionState
extends Enum<ConnectionState>

The state of an Ice connection.

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
ConnectionStateActive	The connection is active and can send and receive messages.
ConnectionStateClosed	The connection is closed and waits for potential dispatch to be finished before being destroyed and detached from the observer.
ConnectionStateClosing	The connection is being gracefully shutdown and waits for the peer to close its end of the connection.
ConnectionStateHolding	The connection is holding the reception of new messages.
ConnectionStateValidating	The connection is being validated.

Method Summary

Modifier and Type	Method	Description
int	value()
static ConnectionState	valueOf(int v)	Returns the enum constant of this class with the specified name.
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

ConnectionStateValidating

public static final ConnectionState ConnectionStateValidating

The connection is being validated.

ConnectionStateHolding

public static final ConnectionState ConnectionStateHolding

The connection is holding the reception of new messages.

ConnectionStateActive

public static final ConnectionState ConnectionStateActive

The connection is active and can send and receive messages.

ConnectionStateClosing

public static final ConnectionState ConnectionStateClosing

The connection is being gracefully shutdown and waits for the peer to close its end of the connection.

ConnectionStateClosed

public static final ConnectionState ConnectionStateClosed

The connection is closed and waits for potential dispatch to be finished before being destroyed and detached from the observer.

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

value

public int value()

valueOf

public static ConnectionState valueOf(int v)

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:

v - 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