Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: b91d919ebf9a6052afd8b99d415805f7c1a0bff9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
package org.eclipse.net4j.transport;

import org.eclipse.net4j.util.lifecycle.ILifecycle;
import org.eclipse.net4j.util.lifecycle.LifecycleUtil;

/**
 * Enumerates the lifecycle states of an {@link IConnector}.
 * <p>
 * <dt><b>State Machine Diagram:</b></dt>
 * <dd><img src="doc-files/ConnectorStates.png" title="Diagram Connector
 * States" border="0" usemap="#ConnectorStates.png"/></dd>
 * <p>
 * <MAP NAME="ConnectorStates.png"> <AREA SHAPE="RECT" COORDS="26,135,143,159"
 * HREF="ConnectorState.html#DISCONNECTED"> <AREA SHAPE="RECT"
 * COORDS="449,50,547,73" HREF="ConnectorState.html#CONNECTING"> <AREA
 * SHAPE="RECT" COORDS="449,133,549,159" HREF="ConnectorState.html#NEGOTIATING">
 * <AREA SHAPE="RECT" COORDS="451,216,545,240"
 * HREF="ConnectorState.html#CONNECTED"> <AREA SHAPE="POLYGON"
 * COORDS="10,89,11,183,164,183,163,109,77,109,77,89,11,88"
 * HREF="../util/lifecycle/ILifecycle.Introspection.html#isActive()"> <AREA
 * SHAPE="POLYGON" COORDS="429,10,428,262,597,263,597,30,483,29,483,10,428,11"
 * HREF="../util/lifecycle/ILifecycle.Introspection.html#isActive()"> </MAP>
 * 
 * @see IConnector#getState()
 * @author Eike Stepper
 * @since 0.8.0
 */
public enum ConnectorState
{
  /**
   * Indicates that the {@link IConnector} has not been connected yet or has
   * been disconnected after being connected previously.
   * <p>
   * A connector is <code>DISCONNECTED</code> if and only if it is not
   * {@link LifecycleUtil#isActive(Object) active}. A transition to
   * {@link #CONNECTING} can be triggered by calling
   * {@link IConnector#connect(long)} or {@link IConnector#connectAsync()}.
   * 
   * @see IConnector#getState()
   * @see ILifecycle.Introspection#isActive()
   */
  DISCONNECTED,

  /**
   * Indicates that the {@link IConnector} is currently trying to establish an
   * underlying physical connection like a TCP socket connection.
   * <p>
   * A connector can only be <code>CONNECTING</code> if it is
   * {@link LifecycleUtil#isActive(Object) active}. As soon as the underlying
   * physical connection is successfully established the state of the connector
   * automatically transitions to {@link #NEGOTIATING}.
   * 
   * @see IConnector#getState()
   * @see ILifecycle.Introspection#isActive()
   */
  CONNECTING,

  /**
   * Indicates that the {@link IConnector} has successfully managed to establish
   * the underlying physical connection and has currently delegated control over
   * this connection to an {@link IConnectorNegotiator}.
   * <p>
   * A connector can only be <code>NEGOTIATING</code> if it is
   * {@link LifecycleUtil#isActive(Object) 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 {@link #CONNECTED}.
   * <p>
   * 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 IConnector#getState()
   * @see ILifecycle.Introspection#isActive()
   */
  NEGOTIATING,

  /**
   * Indicates that the {@link IConnector} has successfully managed to establish
   * and negotiate the underlying physical connection and is ready now to
   * perform actual communications.
   * <p>
   * A connector can only be <code>CONNECTED</code> if it is
   * {@link LifecycleUtil#isActive(Object) active}. A transition to
   * {@link #DISCONNECTED} can be triggered by calling
   * {@link IConnector#disconnect()}.
   * 
   * @see IConnector#getState()
   * @see ILifecycle.Introspection#isActive()
   */
  CONNECTED
}

Back to the top