Open MPI logo

MPI_Comm_connect(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Comm_connectR] - Establishes communication with a server.

Syntax

C Syntax



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



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_COMM_CONNECT(PORT_NAME, INFO, ROOT, COMM, NEWCOMM, IERROR) CHARACTER*(*) PORT_NAME INTEGER INFO, ROOT, COMM, NEWCOMM, IERRORR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Comm_connect(port_name, info, root, comm, newcomm, ierror) CHARACTER(LEN=*), INTENT(IN) :: port_name TYPE(MPI_Info), INTENT(IN) :: info INTEGER, INTENT(IN) :: root TYPE(MPI_Comm), INTENT(IN) :: comm TYPE(MPI_Comm), INTENT(OUT) :: newcomm INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

[bu]
C]port_nameR] : Port name (string, used only on I]rootR]).
[bu]
C]infoR] : Options given by root for the connect (handle, used only on root). No options currently supported.
[bu]
C]rootR] : Rank in I]commR] of root node (integer).
[bu]
C]commR] : Intracommunicator over which call is collective (handle).

Output Parameters

[bu]
C]newcommR] : Intercommunicator with client as remote group (handle)
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_Comm_connectR] establishes communication with a server specified by C]port_nameR]. It is collective over the calling communicator and returns an intercommunicator in which the remote group participated in an C]MPI_Comm_acceptR]. The C]MPI_Comm_connectR] call must only be called after the C]MPI_Comm_acceptR] call has been made by the MPI job acting as the server. If the named port does not exist (or has been closed), C]MPI_Comm_connectR] raises an error of class C]MPI_ERR_PORTR]. 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 C]port_nameR] parameter is the address of the server. It must be the same as the name returned by C]MPI_Open_portR] 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. 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 C]MPI_Comm_set_errhandlerR]; the predefined error handler C]MPI_ERRORS_RETURNR] 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

C]MPI_Comm_acceptR](3) C]MPI_Open_portR](3)


Table of Contents

« Return to documentation listing