Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_unpublish_name(3openmpi) [osx man page]

MPI_Unpublish_name(3OpenMPI)											      MPI_Unpublish_name(3OpenMPI)

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) INPUT PARAMETERS
service_name A service name (string). info Options to the name service functions (handle). No options currently supported. 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. The info parameter should be MPI_INFO_NULL, as this routine does not parse any MPI Info arguments. 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++ func- tions 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 Open MPI 1.2 March 2007 MPI_Unpublish_name(3OpenMPI)

Check Out this Related Man Page

MPI_Publish_name(3)						      LAM/MPI						       MPI_Publish_name(3)

MPI_Publish_name - Publish a service name for dynamic process control SYNOPSIS
#include <mpi.h> int MPI_Publish_name(char *service_name, MPI_Info info, char *port_name) INPUT PARAMETERS
service_name - a service name to associate with the port info - implementation-specific information port_name - a port name from MPI_Open_port NOTES
Currently, LAM/MPI ignores any info keys that are passed to this function. As such, info keys specific to a different implementation can safely be passed to this function. Additionally, the MPI constant MPI_INFO_NULL can also be used. The scope of the published name is the LAM universe -- MPI processes running on any node included from the initial lamboot are capable of retrieving a name published by MPI_Publish_name . Service names stay in existence until they are either manually removed with MPI_Unpublish_name or cleaned with the lamclean command. It is a common mistake to forget to MPI_Unpublish_name at the end of a run, and therefore leave published names in the LAM runtime environ- ment. NOTES FOR FORTRAN
All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument list. ierr is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the call statement. All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran. ERRORS
If an error occurs in an MPI function, the current MPI error handler is called to handle it. By default, this error handler aborts the MPI job. The error handler may be changed with MPI_Errhandler_set ; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned (in C and Fortran; this error handler is less useful in with the C++ MPI bindings. The predefined error handler MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value needs to be recovered). Note that MPI does not guarantee that an MPI program can continue past an error. All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the function and Fortran routines in the last argument. The C++ bindings for MPI do not return error values; instead, error values are communicated by throwing exceptions of type MPI::Exception (but not by default). Exceptions are only thrown if the error value is not MPI::SUCCESS . Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI functions will return upon an error, there will be no way to recover what the actual error value was. MPI_SUCCESS - No error; MPI routine completed successfully. MPI_ERR_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class. This is typically a NULL pointer or other such error. MPI_ERR_SERVICE - This error class is associated with an error code that indicates that there was a problem with the service name that was used. Depending on the context, this can indicate that the service name was already published or that the service name was not yet pub- lished. SEE ALSO
MPI_Lookup_name, MPI_Unpublish_name MORE INFORMATION
For more information, please see the official MPI Forum web site, which contains the text of both the MPI-1 and MPI-2 standards. These documents contain detailed information about each MPI function (most of which is not duplicated in these man pages). LOCATION
namepub.c LAM
/MPI 6.5.8 11/10/2002 MPI_Publish_name(3)
Man Page