Skip to main content
Version: v1

ConnectionState Enum

Signature​

export declare enum ConnectionState

Flags​

FlagAlertsDescription
CatchingUpThe container has an inbound connection only, and is catching up to the latest known state from the service.
ConnectedThe container is fully connected and syncing
ConnectingDeprecatedSee CatchingUp, which is the new name for this state.
DisconnectedThe container is not connected to the ordering service Note - When in this state the container may be about to reconnect, or may remain disconnected until explicitly told to connect.
EstablishingConnectionThe 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

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

Connecting​

See CatchingUp, which is the new name for this state.

This API is deprecated and will be removed in a future release.
  • This state itself is not gone, just being renamed. Please use CatchingUp.

Signature​

Connecting = 1

Disconnected​

The container is not connected to the ordering service 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