ConnectionStateType Namespace
Namespace for the different connection states a container can be in. PLEASE NOTE: The sequence of the numerical values does no correspond to the typical connection state progression.
Signature
export declare namespace ConnectionState
Types
| TypeAlias | Description |
|---|---|
| CatchingUp | The container has an inbound connection only, and is catching up to the latest known state from the service. |
| Connected | The container is fully connected and syncing. |
| Disconnected | The container is not connected to the delta server. Note - When in this state the container may be about to reconnect, or may remain disconnected until explicitly told to connect. |
| EstablishingConnection | The container is disconnected but actively trying to establish a new connection. PLEASE NOTE that this numerical value falls out of the order you may expect for this state. |
Variables
| Variable | Modifiers | Type | Description |
|---|---|---|---|
| CatchingUp | readonly |
The container has an inbound connection only, and is catching up to the latest known state from the service. | |
| Connected | readonly |
The container is fully connected and syncing. | |
| Disconnected | readonly |
The container is not connected to the delta server. Note - When in this state the container may be about to reconnect, or may remain disconnected until explicitly told to connect. | |
| EstablishingConnection | readonly |
The container is disconnected but actively trying to establish a new connection. PLEASE NOTE that this numerical value falls out of the order you may expect for this state. |
Variable Details
CatchingUp
The container has an inbound connection only, and is catching up to the latest known state from the service.
Signature
CatchingUp = 1
Connected
The container is fully connected and syncing.
Signature
Connected = 2
Disconnected
The container is not connected to the delta server. Note - When in this state the container may be about to reconnect, or may remain disconnected until explicitly told to connect.
Signature
Disconnected = 0
EstablishingConnection
The container is disconnected but actively trying to establish a new connection. PLEASE NOTE that this numerical value falls out of the order you may expect for this state.
Signature
EstablishingConnection = 3