1 | .\"Copyright 2009, Cisco Systems, Inc. All rights reserved. |
---|
2 | .\"Copyright 2007, Sun Microsystems, Inc. |
---|
3 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
4 | .TH MPI_Comm_accept 3OpenMPI "Dec 08, 2009" "1.4" "Open MPI" |
---|
5 | .SH NAME |
---|
6 | \fBMPI_Comm_accept \fP \- Establishes communication with a client. |
---|
7 | |
---|
8 | .SH SYNTAX |
---|
9 | .ft R |
---|
10 | .SH C Syntax |
---|
11 | .nf |
---|
12 | #include <mpi.h> |
---|
13 | int MPI_Comm_accept(char *\fIport_name\fP, MPI_Info \fIinfo\fP, int \fIroot\fP, MPI_Comm \fIcomm\fP, MPI_Comm *\fInewcomm\fP) |
---|
14 | |
---|
15 | .SH Fortran Syntax |
---|
16 | .nf |
---|
17 | INCLUDE 'mpif.h' |
---|
18 | MPI_COMM_ACCEPT(\fIPORT_NAME, INFO, ROOT, COMM, NEWCOMM, IERROR\fP) |
---|
19 | CHARACTER*(*) \fIPORT_NAME\fP |
---|
20 | INTEGER \fIINFO, ROOT, COMM, NEWCOMM, IERROR\fP |
---|
21 | |
---|
22 | .SH C++ Syntax |
---|
23 | .nf |
---|
24 | #include <mpi.h> |
---|
25 | MPI::Intercomm MPI::Intracomm::Accept(const char* \fIport_name\fP, |
---|
26 | const MPI::Info& \fIinfo\fP, int \fIroot\fP) const |
---|
27 | |
---|
28 | .SH INPUT PARAMETERS |
---|
29 | .ft R |
---|
30 | .TP 1i |
---|
31 | port_name |
---|
32 | Port name (string, used only on \fIroot\fP). |
---|
33 | .TP 1i |
---|
34 | info |
---|
35 | Options given by root for the accept (handle, used only on root). No options currently supported. |
---|
36 | .TP 1i |
---|
37 | root |
---|
38 | Rank in \fIcomm\fP of root node (integer). |
---|
39 | .TP 1i |
---|
40 | comm |
---|
41 | Intracommunicator over which call is collective (handle). |
---|
42 | |
---|
43 | .SH OUTPUT PARAMETERS |
---|
44 | .ft R |
---|
45 | .TP 1i |
---|
46 | newcomm |
---|
47 | Intercommunicator with client as remote group (handle) |
---|
48 | .TP 1i |
---|
49 | IERROR |
---|
50 | Fortran only: Error status (integer). |
---|
51 | |
---|
52 | .SH DESCRIPTION |
---|
53 | .ft R |
---|
54 | MPI_Comm_accept establishes communication with a client. It is collective over the calling communicator. It returns an intercommunicator that allows communication with the client, after the client has connected with the MPI_Comm_accept function using the MPI_Comm_connect function. |
---|
55 | .sp |
---|
56 | The \fIport_name\fP must have been established through a call to MPI_Open_port on the root. |
---|
57 | |
---|
58 | |
---|
59 | .SH ERRORS |
---|
60 | 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. |
---|
61 | .sp |
---|
62 | Before the error value is returned, the current MPI error handler is |
---|
63 | 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. |
---|
64 | .sp |
---|
65 | See the MPI man page for a full list of MPI error codes. |
---|
66 | |
---|
67 | .SH SEE ALSO |
---|
68 | MPI_Comm_connect |
---|
69 | MPI_Open_port |
---|
70 | .br |
---|
71 | |
---|