1 | .\"Copyright 2007-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Unpublish_name 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | |
---|
5 | .SH NAME |
---|
6 | .nf |
---|
7 | \fBMPI_Unpublish_name\fP \- Unpublishes a service name |
---|
8 | |
---|
9 | .SH SYNTAX |
---|
10 | .ft R |
---|
11 | |
---|
12 | .SH C Syntax |
---|
13 | .nf |
---|
14 | #include <mpi.h> |
---|
15 | int MPI_Unpublish_name(char *\fIservice_name\fP, MPI_Info \fIinfo\fP, |
---|
16 | char *\fIport_name\fP) |
---|
17 | |
---|
18 | .SH Fortran Syntax |
---|
19 | .nf |
---|
20 | INCLUDE 'mpif.h' |
---|
21 | MPI_UNPUBLISH_NAME(\fISERVICE_NAME, INFO, PORT_NAME, IERROR\fP) |
---|
22 | CHARACTER*(*) \fISERVICE_NAME, PORT_NAME\fP |
---|
23 | INTEGER \fIINFO, IERROR\fP |
---|
24 | |
---|
25 | .SH C++ Syntax |
---|
26 | .nf |
---|
27 | #include <mpi.h> |
---|
28 | void MPI::Unpublish_name(const char* \fIservice_name\fP, const MPI::Info& \fIinfo\fP, |
---|
29 | char* \fIport_name\fP) |
---|
30 | |
---|
31 | .SH INPUT PARAMETERS |
---|
32 | .ft R |
---|
33 | .TP 1.4i |
---|
34 | service_name |
---|
35 | A service name (string). |
---|
36 | .TP 1.4i |
---|
37 | info |
---|
38 | Options to the name service functions (handle). |
---|
39 | .ft R |
---|
40 | .TP 1.4i |
---|
41 | port_name |
---|
42 | A port name (string). |
---|
43 | |
---|
44 | .SH OUTPUT PARAMETER |
---|
45 | .TP 1.4i |
---|
46 | IERROR |
---|
47 | Fortran only: Error status (integer). |
---|
48 | |
---|
49 | .SH DESCRIPTION |
---|
50 | .ft R |
---|
51 | This routine removes the pair (\fIservice_name, port_name\fP) so that |
---|
52 | applications may no longer retrieve \fIport_name\fP by calling |
---|
53 | MPI_Lookup_name. It is an error to unpublish a \fIservice_name\fP |
---|
54 | that was not published via MPI_Publish_name. Both the \fIservice_name\fP |
---|
55 | and \fIport_name\fP arguments to MPI_Unpublish_name must be identical |
---|
56 | to the arguments to the previous call to MPI_Publish_name. |
---|
57 | |
---|
58 | .SH INFO ARGUMENTS |
---|
59 | The following keys for \fIinfo\fP are recognized: |
---|
60 | .sp |
---|
61 | .sp |
---|
62 | .nf |
---|
63 | Key Type Description |
---|
64 | --- ---- ----------- |
---|
65 | |
---|
66 | ompi_global_scope bool If set to true, unpublish the name from |
---|
67 | the global scope. Unpublish from the local |
---|
68 | scope otherwise. See the NAME SCOPE |
---|
69 | section for more details. |
---|
70 | |
---|
71 | .fi |
---|
72 | |
---|
73 | .sp |
---|
74 | \fIbool\fP info keys are actually strings but are evaluated as |
---|
75 | follows: if the string value is a number, it is converted to an |
---|
76 | integer and cast to a boolean (meaning that zero integers are false |
---|
77 | and non-zero values are true). If the string value is |
---|
78 | (case-insensitive) "yes" or "true", the boolean is true. If the |
---|
79 | string value is (case-insensitive) "no" or "false", the boolean is |
---|
80 | false. All other string values are unrecognized, and therefore false. |
---|
81 | .PP |
---|
82 | If no info key is provided, the function will first check to see if a |
---|
83 | global server has been specified and is available. If so, then the |
---|
84 | unpublish function will default to global scope first, followed by local. Otherwise, |
---|
85 | the data will default to unpublish with local scope. |
---|
86 | |
---|
87 | .SH NAME SCOPE |
---|
88 | Open MPI supports two name scopes: \fIglobal\fP and \fIlocal\fP. Local scope |
---|
89 | values are placed in a data store located on the mpirun of the calling |
---|
90 | process' job, while global scope values reside on a central server. Calls |
---|
91 | to MPI_Unpublish_name must correctly specify the scope to be used in |
---|
92 | finding the value to be removed. The function will return an error if |
---|
93 | the specified service name is not found on the indicated location. |
---|
94 | .sp |
---|
95 | For a more detailed description of scoping rules, please see the MPI_Publish_name |
---|
96 | man page. |
---|
97 | |
---|
98 | .SH ERRORS |
---|
99 | .ft R |
---|
100 | Almost all MPI routines return an error value; C routines as |
---|
101 | the value of the function and Fortran routines in the last argument. C++ |
---|
102 | functions do not return errors. If the default error handler is set to |
---|
103 | MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism |
---|
104 | will be used to throw an MPI:Exception object. |
---|
105 | .sp |
---|
106 | Before the error value is returned, the current MPI error handler is |
---|
107 | called. By default, this error handler aborts the MPI job, except for |
---|
108 | I/O function errors. The error handler may be changed with |
---|
109 | MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN |
---|
110 | may be used to cause error values to be returned. Note that MPI does not |
---|
111 | guarantee that an MPI program can continue past an error. |
---|
112 | .sp |
---|
113 | See the MPI man page for a full list of MPI error codes. |
---|
114 | |
---|
115 | .SH SEE ALSO |
---|
116 | .ft R |
---|
117 | .nf |
---|
118 | MPI_Publish_name |
---|
119 | MPI_Lookup_name |
---|
120 | MPI_Open_port |
---|
121 | |
---|
122 | |
---|