[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_Recv_init 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_Recv_init\fP \- Builds a handle for a receive. |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .ft R |
---|
| 9 | .SH C Syntax |
---|
| 10 | .nf |
---|
| 11 | #include <mpi.h> |
---|
| 12 | int MPI_Recv_init(void *\fIbuf\fP, int\fI count\fP, MPI_Datatype\fI datatype\fP, |
---|
| 13 | int\fI source\fP, int\fI tag\fP, MPI_Comm\fI comm\fP, MPI_Request\fI *request\fP) |
---|
| 14 | |
---|
| 15 | .SH Fortran Syntax |
---|
| 16 | .nf |
---|
| 17 | INCLUDE 'mpif.h' |
---|
| 18 | MPI_RECV_INIT(\fIBUF, COUNT, DATATYPE, SOURCE, TAG, COMM, REQUEST, |
---|
| 19 | IERROR\fP) |
---|
| 20 | <type> \fIBUF\fP(*) |
---|
| 21 | INTEGER \fICOUNT, DATATYPE, SOURCE, TAG, COMM, REQUEST, IERROR\fP |
---|
| 22 | |
---|
| 23 | .SH C++ Syntax |
---|
| 24 | .nf |
---|
| 25 | #include <mpi.h> |
---|
| 26 | Prequest Comm::Recv_init(void* \fIbuf\fP, int \fIcount\fP, const |
---|
| 27 | Datatype& \fIdatatype\fP, int \fIsource\fP, int \fItag\fP) const |
---|
| 28 | |
---|
| 29 | .SH INPUT PARAMETERS |
---|
| 30 | .ft R |
---|
| 31 | .TP 1i |
---|
| 32 | count |
---|
| 33 | Maximum number of elements to receive (integer). |
---|
| 34 | .TP 1i |
---|
| 35 | datatype |
---|
| 36 | Type of each entry (handle). |
---|
| 37 | .TP 1i |
---|
| 38 | source |
---|
| 39 | Rank of source (integer). |
---|
| 40 | .TP 1i |
---|
| 41 | tag |
---|
| 42 | Message tag (integer). |
---|
| 43 | .TP 1i |
---|
| 44 | comm |
---|
| 45 | Communicator (handle). |
---|
| 46 | |
---|
| 47 | .SH INPUT/OUTPUT PARAMETER |
---|
| 48 | .TP 1i |
---|
| 49 | buf |
---|
| 50 | Initial address of receive buffer (choice). |
---|
| 51 | |
---|
| 52 | .SH OUTPUT PARAMETERS |
---|
| 53 | .ft R |
---|
| 54 | .TP 1i |
---|
| 55 | request |
---|
| 56 | Communication request (handle). |
---|
| 57 | .ft R |
---|
| 58 | .TP 1i |
---|
| 59 | IERROR |
---|
| 60 | Fortran only: Error status (integer). |
---|
| 61 | |
---|
| 62 | .SH DESCRIPTION |
---|
| 63 | .ft R |
---|
| 64 | Creates a persistent communication request for a receive operation. The argument \fIbuf\fP is marked as OUT because the user gives permission to write on the receive buffer by passing the argument to MPI_Recv_init. |
---|
| 65 | .sp |
---|
| 66 | A persistent communication request is inactive after it is created -- no active communication is attached to the request. |
---|
| 67 | .sp |
---|
| 68 | A communication (send or receive) that uses a persistent request is initiated by the function MPI_Start or MPI_Startall. |
---|
| 69 | |
---|
| 70 | .SH ERRORS |
---|
| 71 | 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. |
---|
| 72 | .sp |
---|
| 73 | Before the error value is returned, the current MPI error handler is |
---|
| 74 | 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. |
---|
| 75 | |
---|
| 76 | .SH SEE ALSO |
---|
| 77 | .ft R |
---|
| 78 | .sp |
---|
| 79 | MPI_Bsend_init |
---|
| 80 | .br |
---|
| 81 | MPI_Rsend_init |
---|
| 82 | .br |
---|
| 83 | MPI_Send_init |
---|
| 84 | .br |
---|
| 85 | MPI_Sssend_init |
---|
| 86 | .br |
---|
| 87 | MPI_Start |
---|
| 88 | .br |
---|
| 89 | MPI_Startall |
---|
| 90 | .br |
---|
| 91 | MPI_Request_free |
---|
| 92 | |
---|