APIs, concepts, guides, and more

◆ NetworkSyncGroupStatusGet()

NetworkSyncGroupStatus NetworkSyncGroupStatusGet ( int32_t groupId)
Description:
Returns a NetworkSyncGroupStatus snapshot for the given group. Use this to detect a degraded or absent group (member nodes out of OP, disconnected, or unpowered, tolerated without a fatal network error) and to confirm recovery. The State field follows this state machine:

State, ActualWkc, and DataValid react within a few network samples of a fault; the per-node OperationalNodeCount and NonOperationalNodeMask are attributed about once per second while the group is degraded (see the NetworkSyncGroupStatus notes). The same fields are recordable via the NETWORK_SYNC_GROUP_* members of RSIControllerAddressType, with the group id as the object index. See Sync Groups for the full concept.

Parameters
groupIdSync group index in the range [0, NetworkSyncGroupCountMaximum).
Returns
(NetworkSyncGroupStatus) A structure containing current sync group status values.
See also
NetworkSyncGroupStatus, NetworkSyncGroupCountGet, NetworkSyncGroupRecover, RSINetworkSyncGroupState