18.3.34. pmix_link_state_t

pmix_link_state_t — Describes the state of a fabric device port

18.3.34.1. SYNTAX

18.3.34.1.1. C Syntax

#include <pmix_common.h>

typedef uint8_t pmix_link_state_t;

#define PMIX_LINK_STATE_UNKNOWN     0
#define PMIX_LINK_DOWN              1
#define PMIX_LINK_UP                2

18.3.34.2. DESCRIPTION

The pmix_link_state_t type is an 8-bit unsigned integer describing the last available physical port state of a fabric device. It takes one of the following values:

PMIX_LINK_STATE_UNKNOWN (0)

The port state is unknown or not applicable.

PMIX_LINK_DOWN (1)

The port is inactive.

PMIX_LINK_UP (2)

The port is active.

A link state is conveyed, for example, via the PMIX_FABRIC_DEVICE_STATE attribute. The PMIx_Link_state_string(3) function returns a string representation of a pmix_link_state_t value.

See also

PMIx_Link_state_string(3), PMIx_Fabric_register(3), pmix_info_t(5)