1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
|
.TH MPI_Comm_accept 3 "6/24/2006" "LAM/MPI 7.1.4" "LAM/MPI"
.SH NAME
MPI_Comm_accept \- Accept a connection from another MPI process
.SH SYNOPSIS
.nf
#include <mpi.h>
int
MPI_Comm_accept(char *port_name, MPI_Info info, int root, MPI_Comm comm,
MPI_Comm *newcomm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B port_name
- port name (only used at root)
.PD 1
.PD 0
.TP
.B info
- extra information handle (only used at root)
.PD 1
.PD 0
.TP
.B root
- rank in comm of root node
.PD 1
.PD 0
.TP
.B comm
- intracommunicator over which the call is collective
.PD 1
.SH OUTPUT PARAMETER
.PD 0
.TP
.B newcomm
- intercommunicator with client as remote group
.PD 1
.SH DESCRIPTION
The
.I MPI_Comm_accept
and
.I MPI_Comm_connect
calls simulate the
well-understood
.I accept()
/
.I connect()
semantics of standard socket
programming -- a client "connects" to a server.
LAM/MPI allows for previously-unrelated MPI programs to join into a
MPI program with these calls. Both MPI programs must be running by
the same user in the same LAM universe (i.e., in the scope of a single
lamboot).
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
)
have an additional argument
.I ierr
at the end of the argument list.
.I 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
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH USAGE WITH IMPI EXTENSIONS
The IMPI standard only supports MPI-1 functions. Hence, this function
is currently not designed to operate within an IMPI job.
.SH ERRORS
If an error occurs in an MPI function, the current MPI error handler
is called to handle it. By default, this error handler aborts the
MPI job. The error handler may be changed with
.I MPI_Errhandler_set
;
the predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause
error values to be returned (in C and Fortran; this error handler is
less useful in with the C++ MPI bindings. The predefined error
handler
.I MPI::ERRORS_THROW_EXCEPTIONS
should be used in C++ if the
error value needs to be recovered). Note that MPI does
.I not
guarantee that an MPI program can continue past an error.
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error
value; C routines as the value of the function and Fortran routines
in the last argument. The C++ bindings for MPI do not return error
values; instead, error values are communicated by throwing exceptions
of type
.I MPI::Exception
(but not by default). Exceptions are only
thrown if the error value is not
.I MPI::SUCCESS
\&.
Note that if the
.I MPI::ERRORS_RETURN
handler is set in C++, while
MPI functions will return upon an error, there will be no way to
recover what the actual error value was.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a
null communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_ROOT
- Invalid root. The root must be specified as a rank
in the communicator. Ranks must be between zero and the size of the
communicator minus one.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class. This is typically a NULL
pointer or other such error.
.PD 1
.PD 0
.TP
.B MPI_ERR_INTERN
- An internal error has been detected. This is
fatal. Please send a bug report to the LAM mailing list (see
.I http://www.lam-mpi.org/contact.php
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more
information about this error code.
.PD 1
.PD 0
.TP
.B MPI_ERR_FLAGS
- Mismatch of run-time flags. For example, an MPI
process that is running in lamd mode cannot spawn or be connected to a
process that is running in c2c mode.
.PD 1
.SH SEE ALSO
MPI_Close_port(3), MPI_Comm_connect(3), MPI_Comm_disconnect(3), MPI_Open_port(3)
.br
.SH MORE INFORMATION
For more information, please see the official MPI Forum web site,
which contains the text of both the MPI-1 and MPI-2 standards. These
documents contain detailed information about each MPI function (most
of which is not duplicated in these man pages).
.I http://www.mpi-forum.org/
.SH LOCATION
accept.c
|