18.2.242. PMIx_Multicluster_nspace_construct

PMIx_Multicluster_nspace_construct — Combine a cluster and a namespace into a single multicluster pmix_nspace_t(5)

18.2.242.1. SYNOPSIS

#include <pmix.h>

void PMIx_Multicluster_nspace_construct(pmix_nspace_t target,
                                        pmix_nspace_t cluster,
                                        pmix_nspace_t nspace);

18.2.242.1.1. Python Syntax

No Python equivalent

18.2.242.2. INPUT/OUTPUT PARAMETERS

target: The pmix_nspace_t(5) (a fixed-size character array, supplied by the caller) into which the combined value is written.
cluster: The cluster identifier portion.
nspace: The namespace portion.

18.2.242.3. DESCRIPTION

Build a combined multicluster namespace of the form cluster:nspace in target. The target array is first cleared, then the cluster string, a ':' separator, and the nspace string are concatenated into it.

The combined result must fit within PMIX_MAX_NSLEN characters. If the sum of the cluster and namespace lengths would meet or exceed PMIX_MAX_NSLEN, no concatenation is performed and target is left cleared (empty). Callers that need to recover the two components can pass the result to PMIx_Multicluster_nspace_parse(3).

18.2.242.4. RETURN VALUE

PMIx_Multicluster_nspace_construct returns no value (void).

18.2.242.5. NOTES

PMIx_Multicluster_nspace_construct is an OpenPMIx convenience routine and is the backing implementation of the PMIX_MULTICLUSTER_NSPACE_CONSTRUCT macro. Because the combined value must share the single PMIX_MAX_NSLEN budget of a pmix_nspace_t, the cluster and namespace components must together be short enough to leave room for the separator.