MPISynqNetRecoveryMode

Definition

typedef enum MPISynqNetRecoveryMode {
  MPISynqNetRecoveryModeINVALID = -1,

  MPISynqNetRecoveryModeDISABLED,
  MPISynqNetRecoveryModeSINGLE_SHOT,
  MPISynqNetRecoveryModeAUTO_ARM,

  MPISynqNetRecoveryModeLAST,
  MPISynqNetRecoveryModeFIRST = MPISynqNetRecoveryModeINVALID + 1
} MPISynqNetRecoveryMode;

Description

MPISynqNetRecoveryMode is an enumeration of a network's fault recovery mode. Networks with ring topologies can be configured to recover from a fault condition. A fault condition occurs when a packet error rate counter exceeds its packet error rate fault limit. If fault recovery is enabled and a fault occurs, the node hardware and/or controller will detect the location of the fault and switch the direction of network traffic for nodes downstream from the faulted connection. During fault recovery, the network state is MPISynqNetStateSYNQ_RECOVERING. After the upstream and downstream packet error rate counters decrement to zero, the recovery is completed, and the network state returns to MPISynqNetStateSYNQ.

When fault recovery occurs, the controller will generate a MPIEventTypeSYNQNET_RECOVERY status/event. An application should notify the user about the fault and fix the broken cable/hardware as soon as possible. An application can determine the location of the fault using mpiSynqNetIdleCableListGet(...). A network with a ring topology has one idle cable, which has no data traffic. The operation of the idle cable can be tested with mpiSynqNetIdleCableStatus(...).

WARNING: If the idle cable is broken and a second fault occurs, then fault recovery will not be able to fully recover from the fault. SynqNet will try to recover, but some nodes will be stranded. Presently, SynqNet does not support an event to notify the application if an idle cable fails. In the meantime, an application can periodically poll the idle cable with mpiSynqNetIdleCableStatus(...) to test the cable.

MPISynqNetRecoveryModeDISABLED The network will not attempt to recover from a fault condition. This is the default mode for string topologies.
MPISynqNetRecoveryModeSINGLE_SHOT The network will only attempt to recover from a fault condition one time. A second fault will be ignored.
MPISynqNetRecoveryModeAUTO_ARM The network will attempt to recover from a fault condition. After the fault recovery is complete, the network will automatically be re-armed to respond to another fault condition. This is the default mode for ring topologies.

See Also

mpiSynqNetConfigGet | mpiSynqNetConfigSet | mpiSynqNetStatus | mpiSynqNetInfo | mpiSynqNetIdleCableListGet | mpiSynqNetIdleCableStatus