1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Test_cancelled 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Test_cancelled\fP \- Tests whether a request was canceled. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Test_cancelled(MPI_Status *\fIstatus\fP, int \fI*flag\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_TEST_CANCELLED(\fISTATUS, FLAG, IERROR\fP) |
---|
18 | LOGICAL \fIFLAG\fP |
---|
19 | INTEGER \fISTATUS(MPI_STATUS_SIZE), IERROR\fP |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | bool Status::Is_cancelled() const |
---|
25 | |
---|
26 | .SH INPUT PARAMETER |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | status |
---|
30 | Status object (status). |
---|
31 | |
---|
32 | .SH OUTPUT PARAMETERS |
---|
33 | .ft R |
---|
34 | .TP 1i |
---|
35 | flag |
---|
36 | True if operation was cancelled (logical). |
---|
37 | .ft R |
---|
38 | .TP 1i |
---|
39 | IERROR |
---|
40 | Fortran only: Error status (integer). |
---|
41 | |
---|
42 | .SH DESCRIPTION |
---|
43 | .ft R |
---|
44 | Returns \fIflag\fP = true if the communication associated with the status object |
---|
45 | was canceled successfully. In such a case, all other fields of status (such as \fIcount\fP or \fItag\fP) are undefined. Otherwise, returns \fIflag\fP = false. If a receive operation might be canceled, one should call MPI_Test_cancelled first, to check whether the operation was canceled, before checking on the other fields of the return status. |
---|
46 | |
---|
47 | .SH NOTES |
---|
48 | Cancel can be an expensive operation that should be used only exceptionally. |
---|
49 | |
---|
50 | .SH ERRORS |
---|
51 | 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. |
---|
52 | .sp |
---|
53 | Before the error value is returned, the current MPI error handler is |
---|
54 | 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. |
---|
55 | |
---|
56 | |
---|
57 | |
---|