.\"Copyright 2007, Sun Microsystems, Inc. .\" Copyright (c) 1996 Thinking Machines Corporation .TH MPI_Publish_name 3OpenMPI "March 2007" "Open MPI 1.2" " " .SH NAME .nf \fBMPI_Publish_name\fP \- Publishes a service name associated with a port .SH SYNTAX .ft R .SH C Syntax .nf #include int MPI_Publish_name(char *\fIservice_name\fP, MPI_Info \fIinfo\fP, char *\fIport_name\fP) .SH Fortran Syntax .nf INCLUDE 'mpif.h' MPI_PUBLISH_NAME(\fISERVICE_NAME, INFO, PORT_NAME, IERROR\fP) CHARACTER*(*) \fISERVICE_NAME, PORT_NAME\fP INTEGER \fIINFO, IERROR\fP .SH C++ Syntax .nf #include void MPI::Publish_name(const char* \fIservice_name\fP, const MPI::Info& \fIinfo\fP, const char* \fIport_name\fP) .SH INPUT PARAMETERS .ft R .TP 1.4i service_name A service name (string). .TP 1.4i info Options to the name service functions (handle). .ft R .TP 1.4i port_name A port name (string). .SH OUTPUT PARAMETER .TP 1.4i IERROR Fortran only: Error status (integer). .SH DESCRIPTION .ft R This routine publishes the pair (\fIservice_name, port_name\fP) so that an application may retrieve \fIport_name\fP by calling MPI_Lookup_name with \fIservice_name\fP as an argument. It is an error to publish the same \fIservice_name\fP twice, or to use a \fIport_name\fP argument that was not previously opened by the calling process via a call to MPI_Open_port. .SH INFO ARGUMENTS The following keys for \fIinfo\fP are recognized: .sp .sp .nf Key Type Description --- ---- ----------- ompi_global_scope bool If set to true, publish the name in the global scope. Publish in the local scope otherwise. See the NAME SCOPE section for more details. .fi .sp \fIbool\fP 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. .SH NAME SCOPE RHC fill in here :-) .SH ERRORS .ft R 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. .sp 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. .sp See the MPI man page for a full list of MPI error codes. .SH SEE ALSO .ft R .nf MPI_Lookup_name MPI_Open_port