18.3.30. pmix_resource_block_directive_t

pmix_resource_block_directive_t — Directive specifying a resource block request

18.3.30.1. SYNTAX

18.3.30.1.1. C Syntax

#include <pmix_common.h>

typedef uint8_t pmix_resource_block_directive_t;

#define PMIX_RESOURCE_BLOCK_DEFINE  1
#define PMIX_RESOURCE_BLOCK_EXTEND  2
#define PMIX_RESOURCE_BLOCK_REMOVE  3
#define PMIX_RESOURCE_BLOCK_DELETE  4

/* define a value boundary beyond which implementers are free
 * to define their own directive values */
#define PMIX_RESOURCE_BLOCK_EXTERNAL     128

18.3.30.2. DESCRIPTION

The pmix_resource_block_directive_t type indicates the nature of a resource block request passed to PMIx_Resource_block(3). It is an 8-bit unsigned integer taking one of the following values:

PMIX_RESOURCE_BLOCK_DEFINE (1)

Define a new resource block.

PMIX_RESOURCE_BLOCK_EXTEND (2)

Extend an existing block definition by adding the specified resources to the block.

PMIX_RESOURCE_BLOCK_REMOVE (3)

Remove the specified resources from the block definition.

PMIX_RESOURCE_BLOCK_DELETE (4)

Delete the resource block definition.

Values at or above PMIX_RESOURCE_BLOCK_EXTERNAL (128) define a boundary beyond which implementers are free to define their own directive values.

The PMIx_Resource_block_directive_string(3) function returns a string representation of a pmix_resource_block_directive_t value.

See also

PMIx_Resource_block(3), PMIx_Resource_block_directive_string(3), pmix_resource_unit_t(5), pmix_info_t(5)