Scroll to navigation

PMIX_MULTICLUSTER_NSPACE_CONSTRUCT(3) OpenPMIx PMIX_MULTICLUSTER_NSPACE_CONSTRUCT(3)

PMIx_Multicluster_nspace_construct — Combine a cluster and a namespace into a single multicluster pmix_nspace_t(5) <#man5-pmix-nspace-t>

SYNOPSIS

#include <pmix.h>
void PMIx_Multicluster_nspace_construct(pmix_nspace_t target,


                                        pmix_nspace_t cluster,


                                        pmix_nspace_t nspace);


Python Syntax

No Python equivalent

INPUT/OUTPUT PARAMETERS

  • target: The pmix_nspace_t(5) <#man5-pmix-nspace-t> (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.

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) <#man3-pmix-multicluster-nspace-parse>.

RETURN VALUE

PMIx_Multicluster_nspace_construct returns no value (void).

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 <#man5-pmix-nspace-t>, the cluster and namespace components must together be short enough to leave room for the separator.

See also:

PMIx_Multicluster_nspace_parse(3) <#man3-pmix-multicluster-nspace-parse>, PMIx_Load_nspace(3) <#man3-pmix-load-nspace>, pmix_nspace_t(5) <#man5-pmix-nspace-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026