18.3.29. pmix_alloc_inheritance_t

pmix_alloc_inheritance_t — Inheritance rules to be applied to an allocation

18.3.29.1. SYNTAX

18.3.29.1.1. C Syntax

#include <pmix_common.h>

typedef uint8_t pmix_alloc_inheritance_t;

#define PMIX_ALLOC_INHERIT_NONE          1
#define PMIX_ALLOC_INHERIT_CHILD         2
#define PMIX_ALLOC_INHERIT_DEFAULT       3
#define PMIX_ALLOC_INHERIT_CHILD_DEFAULT 4

18.3.29.2. DESCRIPTION

The pmix_alloc_inheritance_t type specifies the inheritance rules to be applied to an allocation — that is, what is to become of the allocated resources upon termination of the owning namespace. It is an 8-bit unsigned integer taking one of the following values:

PMIX_ALLOC_INHERIT_NONE (1): No one is to inherit the allocation — it will be released upon termination of the owning namespace.
PMIX_ALLOC_INHERIT_CHILD (2): The allocation is to remain alive until all child namespaces have terminated, including derived children.
PMIX_ALLOC_INHERIT_DEFAULT (3): The allocation is to become unreserved upon termination of the owning namespace.
PMIX_ALLOC_INHERIT_CHILD_DEFAULT (4): The allocation is to become unreserved upon termination of the last derived child namespace.

An inheritance value is passed to PMIx_Allocation_request(3) via the PMIX_ALLOC_INHERITANCE attribute. The PMIx_Alloc_inheritance_string(3) function returns a string representation of a pmix_alloc_inheritance_t value.