MPI_Comm_join function

Creates a communicator by joining two processes connected by a socket.

Syntax

int MPIAPI MPI_Comm_join(
        int      fd,
  _Out_ MPI_Comm *intercomm
);

Parameters

• fd
  Socket file descriptor.

• intercomm [out]
  New intercommunicator.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_COMM_JOIN(FD, INTERCOMM, IERROR)
        INTEGER FD, INTERCOMM, IERROR

Remarks

The socket must be quiescent before MPI_Comm_join is called and after MPI_Comm_join returns. More specifically, on entry to MPI_Comm_join, a read on the socket will not read any data that was written to the socket before the remote process called MPI_Comm_join.

Requirements

Product	HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities
Header	Mpi.h; Mpif.h
Library	Msmpi.lib
DLL	Msmpi.dll

See also

MPI Process Management Functions