org.eclipse.net4j.connector
Enum ConnectorState

java.lang.Object
  java.lang.Enum<ConnectorState>
      org.eclipse.net4j.connector.ConnectorState

All Implemented Interfaces:

Serializable, Comparable<ConnectorState>

public enum ConnectorState

extends Enum<ConnectorState>

Enumerates the lifecycle states of an IConnector.

See Also:

IConnector.getState()

No Extend

This interface is not intended to be extended by clients.

DISCONNECTED

public static final ConnectorState DISCONNECTED

Indicates that the IConnector has not been connected yet or has been disconnected after being connected previously.

A connector is DISCONNECTED if and only if it is not active. A transition to CONNECTING can be triggered by calling IConnector.connect(long) or IConnector.connectAsync().

See Also:

IConnector.getState(), ILifecycle.isActive()

CONNECTING

public static final ConnectorState CONNECTING

Indicates that the IConnector is currently trying to establish an underlying physical connection like a TCP socket connection.

A connector can only be CONNECTING if it is active. As soon as the underlying physical connection is successfully established the state of the connector automatically transitions to NEGOTIATING.

See Also:

IConnector.getState(), ILifecycle.isActive()

NEGOTIATING

public static final ConnectorState NEGOTIATING

Indicates that the IConnector has successfully managed to establish the underlying physical connection and has currently delegated control over this connection to an INegotiator.

A connector can only be NEGOTIATING if it is active and a negotiator has been supplied. As soon as the negotiator has successfully negotiated both peers (or a negotiator has not been supplied) the state of the connector automatically transitions to CONNECTED.

Negotiators can implement arbitrary handshake protocols, challenge-response sequences or other authentication procedures. They can also be used to initially setup connection encryption if the connector implementation is not able to do so.

See Also:

IConnector.getState(), ILifecycle.isActive()

CONNECTED

public static final ConnectorState CONNECTED

Indicates that the IConnector has successfully managed to establish and negotiate the underlying physical connection and is ready now to perform actual communications.

A connector can only be CONNECTED if it is active. A transition to DISCONNECTED can be triggered by calling Closeable.close().

See Also:

IConnector.getState(), ILifecycle.isActive()

values

public static ConnectorState[] 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 (ConnectorState c : ConnectorState.values())
    System.out.println(c);

Returns:

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

valueOf

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