1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Start 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Start\fP \- Initiates a communication using a persistent request handle. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Start(MPI_Request *\fIrequest\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_START(\fIREQUEST, IERROR\fP) |
---|
18 | INTEGER \fIREQUEST, IERROR\fP |
---|
19 | |
---|
20 | .SH C++ Syntax |
---|
21 | .nf |
---|
22 | #include <mpi.h> |
---|
23 | void Prequest::Start() |
---|
24 | |
---|
25 | .SH INPUT PARAMETER |
---|
26 | .ft R |
---|
27 | .TP 1i |
---|
28 | request |
---|
29 | Communication request (handle). |
---|
30 | |
---|
31 | .SH OUTPUT PARAMETER |
---|
32 | .ft R |
---|
33 | .TP 1i |
---|
34 | IERROR |
---|
35 | Fortran only: Error status (integer). |
---|
36 | |
---|
37 | .SH DESCRIPTION |
---|
38 | .ft R |
---|
39 | A communication (send or receive) that uses a persistent request is initiated by the function MPI_Start. |
---|
40 | .sp |
---|
41 | The argument, request, is a handle returned by one of the persistent communication-request initialization functions (MPI_Send_init, MPI_Bsend_init, MPI_Ssend_init, MPI_Rsend_init, MPI_Recv_init). The associated request should be inactive and becomes active once the call is made. |
---|
42 | .sp |
---|
43 | If the request is for a send with ready mode, then a matching receive should be posted before the call is made. From the time the call is made until after the operation completes, the communication buffer should not be accessed. |
---|
44 | .sp |
---|
45 | The call is local, with semantics similar to the nonblocking communication operations (see Section 3.7 in the MPI-1 Standard, "Nonblocking Communication.") That is, a call to MPI_Start with a request created by MPI_Send_init starts a communication in the same manner as a call to MPI_Isend; a call to MPI_Start with a request created by MPI_Bsend_init starts a communication in the same manner as a call to MPI_Ibsend; and so on. |
---|
46 | |
---|
47 | .SH ERRORS |
---|
48 | 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. |
---|
49 | .sp |
---|
50 | Before the error value is returned, the current MPI error handler is |
---|
51 | 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. |
---|
52 | |
---|
53 | .SH SEE ALSO |
---|
54 | .ft R |
---|
55 | .sp |
---|
56 | MPI_Bsend_init |
---|
57 | .br |
---|
58 | MPI_Rsend_init |
---|
59 | .br |
---|
60 | MPI_Send_init |
---|
61 | .br |
---|
62 | MPI_Sssend_init |
---|
63 | .br |
---|
64 | MPI_Recv_init |
---|
65 | .br |
---|
66 | MPI_Startall |
---|
67 | |
---|
68 | |
---|