getCnxState
getCnxState — retrieves the operational state of the connector object.
DHC_tState getCnxState( | ); |
void;The current state of the connector object, a member of
DHC_tState as defined below.
Retrieves the state of the DataHub connector object. The state is primarily informational, since the user cannot directly change it.
| State | Description |
|---|---|
DHC_STATE_NONE | This is the initial (0) state, and is
immediately changed to DHC_STATE_IDLE within
the constructor unless a fundamental initialization error has
occurred (eg. Window creation). |
DHC_STATE_IDLE | A connection has never been attempted. |
DHC_STATE_INITIALIZED | Internal initialization completed (by the first attempt to connect) and ready to connect. |
DHC_STATE_CONNECTING | Currently in the process of connecting. See
getCnxSubStateString for
detailed connection sub-state. |
DHC_STATE_CONNECTING_CLOSING | This is a transient internal state used to force closure of an open connection before attempting to reconnect. |
DHC_STATE_CONNECTED | A DataHub connection exists. |
DHC_STATE_ERROR | An error was detected. See
getErrString. This is
generally a transient state, since the default behaviour is to
attempt to reconnect. |
DHC_STATE_RETRY_DELAY | The reconnection timer is active and after which an attempt
will be made to reconnect (see
setReconnectionDelay). |