pmix_put(3)

1pmix_put(3)                        @VERSION@                       pmix_put(3)
2
3
4

NAME

6       PMIx_Put - Push a value into the client's namespace
7

SYNOPSIS

9              #include <pmix.h>
10
11              pmix\_status\_t PMIx\_Init(pmix\_scope\_t scope, const char key[], pmix\_value\_t *val);
12

ARGUMENTS

14       scope : Defines a scope for data "put" by PMI per the following:
15
16       (a) PMI_LOCAL  -  the  data is intended only for other application pro‐
17           cesses on the same node.  Data marked  in  this  way  will  not  be
18           included in data packages sent to remote requestors
19
20       (b) PMI_REMOTE  - the data is intended solely for application processes
21           on remote nodes.  Data marked in this way will not be  shared  with
22           other processes on the same node
23
24       (c) PMI_GLOBAL  -  the  data  is to be shared with all other requesting
25           processes, regardless of location
26
27       key : String key identifying the information.  This can be  either  one
28       of the PMIx defined attributes, or a user-defined value
29
30       val  :  Pointer  to  a pmix_value_t structure containing the data to be
31       pushed along with the type of the provided data.
32

DESCRIPTION

34       Push a value into the client's  namespace.   The  client  library  will
35       cache  the  information  locally until PMIx_Commit is called.  The pro‐
36       vided scope value is passed to the local PMIx server, which  will  dis‐
37       tribute the data as directed.
38

RETURN VALUE

40       Returns  PMIX_SUCCESS  on  success.   On error, a negative value corre‐
41       sponding to a PMIx errno is returned.
42

ERRORS

44       PMIx errno values are defined in pmix_common.h.
45

NOTES

47       See 'pmix_common.h' for definition of the pmix_value_t structure.
48

AUTHORS

53       PMIx.
54
55
56
57PMIx Programmer's Manual          2016-03-01                       pmix_put(3)