18.3.45. pmix_endpoint_t

pmix_endpoint_t — An assigned communication endpoint for a fabric device

18.3.45.1. SYNTAX

18.3.45.1.1. C Syntax

#include <pmix_common.h>

typedef struct pmix_endpoint {
    char *uuid;
    char *osname;
    pmix_byte_object_t endpt;
} pmix_endpoint_t;

18.3.45.2. DESCRIPTION

The pmix_endpoint_t structure contains an assigned endpoint for a given fabric device.

The uuid field contains the UUID of the fabric device — a string identifier guaranteed to be unique within the cluster.

The osname field is the local operating system name of the device and is only unique to the node on which the device resides.

The endpt field is a pmix_byte_object_t(5) containing a fabric vendor-specific object identifying the communication endpoint assigned to the process.

As multiple endpoints may be assigned to a given process (e.g., when multiple devices are associated with a package to which the process is bound), fabric endpoints for a process are typically returned as a pmix_data_array_t(5) of pmix_endpoint_t elements.

18.3.45.3. STATIC INITIALIZER

A statically declared pmix_endpoint_t may be initialized with the PMIX_ENDPOINT_STATIC_INIT macro, which sets uuid and osname to NULL and initializes the embedded endpt byte object to its empty state:

pmix_endpoint_t endpoint = PMIX_ENDPOINT_STATIC_INIT;