This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

MPI_Comm_connect(3OpenMPI)                                                        MPI_Comm_connect(3OpenMPI)



NAME
       MPI_Comm_connect  - Establishes communication with a server.


SYNTAX
C Syntax
       #include <mpi.h>
       int MPI_Comm_connect(char *port_name, MPI_Info info, int root,
            MPI_Comm comm, MPI_Comm *newcomm)


Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_COMM_CONNECT(PORT_NAME, INFO, ROOT, COMM, NEWCOMM, IERROR)
            CHARACTER*(*)  PORT_NAME
            INTEGER        INFO, ROOT, COMM, NEWCOMM, IERROR


C++ Syntax
       #include <mpi.h>
       MPI::Intercomm MPI::Intracomm::Connect(const char* port_name,
            const MPI::Info& info, int root) const


INPUT PARAMETERS
       port_name Port name (string, used only on root).

       info      Options  given  by  root  for the connect (handle, used only on root). No options currently
                 supported.

       root      Rank in comm of root node (integer).

       comm      Intracommunicator over which call is collective (handle).


OUTPUT PARAMETERS
       newcomm   Intercommunicator with client as remote group (handle)

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPI_Comm_connect establishes communication with a server specified by  port_name.  It  is  collective
       over the calling communicator and returns an intercommunicator in which the remote group participated
       in an MPI_Comm_accept. The MPI_Comm_connect call must only be called after the  MPI_Comm_accept  call
       has been made by the MPI job acting as the server.

       If  the  named  port  does  not exist (or has been closed), MPI_Comm_connect raises an error of class
       MPI_ERR_PORT.

       MPI provides no guarantee of fairness in servicing connection attempts. That is, connection  attempts
       are  not  necessarily satisfied in the order in which they were initiated, and competition from other
       connection attempts may prevent a particular connection attempt from being satisfied.

       The port_name parameter is the address of the server. It must be the same as  the  name  returned  by
       MPI_Open_port on the server.



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_Comm_accept MPI_Open_port




Open MPI 1.2                                     March 2007                       MPI_Comm_connect(3OpenMPI)