ConnectionStateEnum – OPC Unified Architecture – Part 81: UAFX Connecting Devices and Information Model

10.20 ConnectionStateEnum

The ConnectionStateEnum provides information about the current state of the Connection, as determined by the ConnectionManager. See section 10.19 for a description of the ConnectionState. The ConnectionStateEnum values are formally defined in Table 164.

Table 164 – ConnectionStateEnum items

Name	Value	Description
ConnectionNotMonitored	0	ConnectionManager does not monitor the state of the Connection
ConnectionNotEstablished	1	Connection does not exist
ConnectionInitial	2	Connection is being established, but the communication model is not linked to the ConnectionEndpoint.
ConnectionReady	3	Connection is established, but the communication model is disabled
ConnectionPreOperational	4	Connection is established and enabled, but communication has not started
ConnectionOperational	5	Connection is established, and communication is flowing
ConnectionError	6	Connection is established and enabled, but communication is not possible due to an endpoint error.

ConnectionNotEstablished can result from any of the following:

ConnectionManager has not yet established the Connection;

ConnectionManager has successfully removed the Connection;

ConnectionManager detected that one or both ConnectionEndpoints have been removed (e.g., due to ConnectionEndpoint auto-cleanup or AutomationComponent power-cycle).

ConnectionStateEnum combines the Status of all ConnectionEndpoints participating in a Connection (see 10.20).

For Connection types bidirectional, unidirectional and unidirectional with heartbeat, the value is calculated according to Figure 58.

Endpoint1 Status Endpoint2 Status	Initial	Ready	PreOperational	Operational	Error
Initial	ConnectionInitial	ConnectionInitial	ConnectionInitial	ConnectionInitial	ConnectionInitial
Ready	ConnectionInitial	ConnectionReady	ConnectionReady	ConnectionReady	ConnectionError
PreOperational	ConnectionInitial	ConnectionReady	ConnectionPre Operational	ConnectionPre Operational	ConnectionError
Operational	ConnectionInitial	ConnectionReady	ConnectionPre Operational	ConnectionOperational	ConnectionError
Error	ConnectionInitial	ConnectionError	ConnectionError	ConnectionError	ConnectionError

For Connection types autonomous publisher and autonomous subscriber, the value is calculated according to Figure 59.

Endpoint Status	ConnectionRuntimeState
Initial	ConnectionInitial
Ready	ConnectionReady
PreOperational	ConnectionPreOperational
Operational	ConnectionOperational
Error	ConnectionError

The ConnectionStateEnum representation in the AddressSpace is formally defined in Table 165.

Table 165 – ConnectionStateEnum definition

Attribute	Value
BrowseName	4:ConnectionStateEnum
IsAbstract	False

References	NodeClass	BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration defined in OPC 10000-5
0:HasProperty	Variable	0:EnumValues	0:EnumValueType[]	0:PropertyType

ConformanceUnits
UAFX ConnectionManager Diagnostics