NAME¶
MPI_Unpublish_name - Unpublishes a service name
SYNTAX¶
C Syntax¶
#include <mpi.h>
int MPI_Unpublish_name(char * service_name, MPI_Info info,
char * port_name)
Fortran Syntax¶
INCLUDE 'mpif.h'
MPI_UNPUBLISH_NAME( SERVICE_NAME, INFO, PORT_NAME, IERROR)
CHARACTER*(*) SERVICE_NAME, PORT_NAME
INTEGER INFO, IERROR
C++ Syntax¶
#include <mpi.h>
void MPI::Unpublish_name(const char* service_name, const MPI::Info& info,
char* port_name)
- service_name
- A service name (string).
- info
- Options to the name service functions (handle).
- port_name
- A port name (string).
OUTPUT PARAMETER¶
- IERROR
- Fortran only: Error status (integer).
DESCRIPTION¶
This routine removes the pair (
service_name, port_name) so that
applications may no longer retrieve
port_name by calling
MPI_Lookup_name. It is an error to unpublish a
service_name that was
not published via MPI_Publish_name. Both the
service_name and
port_name arguments to MPI_Unpublish_name must be identical to the
arguments to the previous call to MPI_Publish_name.
INFO ARGUMENTS¶
The following keys for
info are recognized:
Key Type Description
--- ---- -----------
ompi_global_scope bool If set to true, unpublish the name from
the global scope. Unpublish from the local
scope otherwise. See the NAME SCOPE
section for more details.
bool info keys are actually strings but are evaluated as follows: if the
string value is a number, it is converted to an integer and cast to a boolean
(meaning that zero integers are false and non-zero values are true). If the
string value is (case-insensitive) "yes" or "true", the
boolean is true. If the string value is (case-insensitive) "no" or
"false", the boolean is false. All other string values are
unrecognized, and therefore false.
If no info key is provided, the function will first check to see if a global
server has been specified and is available. If so, then the unpublish function
will default to global scope first, followed by local. Otherwise, the data
will default to unpublish with local scope.
NAME SCOPE¶
Open MPI supports two name scopes:
global and
local. Local scope
values are placed in a data store located on the mpirun of the calling
process' job, while global scope values reside on a central server. Calls to
MPI_Unpublish_name must correctly specify the scope to be used in finding the
value to be removed. The function will return an error if the specified
service name is not found on the indicated location.
For a more detailed description of scoping rules, please see the
MPI_Publish_name man page.
ERRORS¶
Almost all MPI routines return an error value; C routines as the value of the
function and Fortran routines in the last argument. C++ functions do not
return errors. If the default error handler is set to
MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will
be used to throw an MPI:Exception object.
Before the error value is returned, the current MPI error handler is called. By
default, this error handler aborts the MPI job, except for I/O function
errors. The error handler may be changed with MPI_Comm_set_errhandler; the
predefined error handler MPI_ERRORS_RETURN may be used to cause error values
to be returned. Note that MPI does not guarantee that an MPI program can
continue past an error.
See the MPI man page for a full list of MPI error codes.
SEE ALSO¶
MPI_Publish_name
MPI_Lookup_name
MPI_Open_port