18.3.13. pmix_pdata_t

pmix_pdata_t — Describes published data returned by a lookup

18.3.13.1. SYNTAX

18.3.13.1.1. C Syntax

#include <pmix_common.h>

typedef struct pmix_pdata {
    pmix_proc_t proc;
    pmix_key_t key;
    pmix_value_t value;
} pmix_pdata_t;

18.3.13.2. DESCRIPTION

The pmix_pdata_t structure is used by PMIx_Lookup(3) to describe the data being accessed. A caller populates the key field of each element with the string key it wishes to retrieve; on successful return, the proc and value fields are filled in with the identity of the publisher and the associated value.

proc — the pmix_proc_t(5) process identifier of the process that published the data.
key — the pmix_key_t(5) string key under which the data was published.
value — the pmix_value_t(5) holding the value associated with key.

Data is placed into the PMIx datastore with PMIx_Publish(3) and later removed with PMIx_Unpublish(3).

18.3.13.3. STATIC INITIALIZER

A statically declared pmix_pdata_t may be initialized with the PMIX_LOOKUP_STATIC_INIT macro, which initializes the embedded proc (with rank set to PMIX_RANK_UNDEF), clears key, and initializes the embedded value (with type set to PMIX_UNDEF):

pmix_pdata_t pdata = PMIX_LOOKUP_STATIC_INIT;

For historical reasons this macro is named PMIX_LOOKUP_STATIC_INIT rather than PMIX_PDATA_STATIC_INIT.