mpi_comm_connect(3openmpi) [osx man page]

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

Open MPI 1.2							    March 2007						MPI_Comm_connect(3OpenMPI)

Check Out this Related Man Page

MPI_Comm_connect(3)							MPI						       MPI_Comm_connect(3)

NAME

       MPI_Comm_connect -  Make a request to form a new intercommunicator

SYNOPSIS

       int MPI_Comm_connect(char *port_name, MPI_Info info, int root, MPI_Comm comm,
			    MPI_Comm *newcomm)

INPUT PARAMETERS

       port_name
	      - network address (string, used only on root)
       info   - implementation-dependent information (handle, used only on root)
       root   - rank in comm of root node (integer)
       comm   - intracommunicator over which call is collective (handle)

OUTPUT PARAMETER

       newcomm
	      - intercommunicator with server as remote group (handle)

THREAD AND INTERRUPT SAFETY

       This  routine  is  thread-safe.	This means that this routine may be safely used by multiple threads without the need for any user-provided
       thread locks.  However, the routine is not interrupt safe.  Typically, this is due to the use of memory allocation routines such as  malloc
       or other non-MPICH runtime routines that are themselves not interrupt-safe.

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

       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.  Before the value is returned, the current MPI error handler is called.  By default, this error handler aborts  the  MPI
       job.   The  error  handler  may	be  changed  with  MPI_Comm_set_errhandler  (for  communicators), MPI_File_set_errhandler (for files), and
       MPI_Win_set_errhandler (for RMA windows).  The MPI-1 routine MPI_Errhandler_set may be used but its  use  is  deprecated.   The	predefined
       error handler MPI_ERRORS_RETURN may be used to cause error values to be returned.  Note that MPI does not guarentee that an MPI program can
       continue past an error; however, MPI implementations will attempt to continue whenever possible.

       MPI_SUCCESS
	      - No error; MPI routine completed successfully.
       MPI_ERR_COMM
	      - Invalid communicator.  A common error is to use a null communicator in a call (not even allowed in MPI_Comm_rank ).
       MPI_ERR_INFO
	      - Invalid Info
       MPI_ERR_PORT
	      -

LOCATION

       comm_connect.c

								     7/27/2010						       MPI_Comm_connect(3)

Linux and UNIX Man Pages

mpi_comm_connect(3openmpi) [osx man page]

Check Out this Related Man Page