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

NAME

6       PMIx_Init - Initialize the PMIx Client
7

SYNOPSIS

9              #include <pmix.h>
10
11              pmix\_status\_t PMIx_Init(pmix\_proc\_t *proc);
12

ARGUMENTS

14       proc  : Pointer to a pmix_proc_t object in which the client's namespace
15       and rank are to be returned.
16

DESCRIPTION

18       Initialize the PMIx client, returning the process  identifier  assigned
19       to this client's application in the provided pmix_proc_t struct.  Pass‐
20       ing a value of NULL for this parameter is allowed if  the  user  wishes
21       solely to initialize the PMIx system and does not require return of the
22       identifier at that time.
23
24       When called, the PMIx client will check  for  the  required  connection
25       information of the local PMIx server and will establish the connection.
26       If the information is not found, or the server connection  fails,  then
27       an appropriate error constant will be returned.
28
29       If  successful, the function will return PMIX_SUCCESS and will fill the
30       provided structure with the server-assigned namespace and rank  of  the
31       process  within  the application.  In addition, all startup information
32       provided by the resource manager will be made available to  the  client
33       process via subsequent calls to PMIx_Get.
34
35       Note  that the PMIx client library is referenced counted, and so multi‐
36       ple calls to PMIx_Init are allowed.  Thus, one way to obtain the names‐
37       pace  and  rank  of  the  process  is  to  simply call PMIx_Init with a
38       non-NULL parameter.
39

RETURN VALUE

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

ERRORS

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

NOTES

SEE ALSO
AUTHORS
50       PMIx.
51
52
53
54PMIx Programmer's Manual          2016-03-01                      pmix_init(3)



        

    


            
        

        

            Impressum