1 | .\"Copyright 2007-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Win_test 3 "Dec 08, 2009" ""1.4"" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Win_test\fP \- Attempts to complete an RMA exposure epoch; a nonblocking version of MPI_Win_wait |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Win_test(MPI_Win \fIwin\fP, int *\fIflag\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_WIN_TEST(\fI WIN, FLAG, IERROR\fP) |
---|
18 | INTEGER \fI WIN, IERROR\fP |
---|
19 | |
---|
20 | .SH C++ Syntax |
---|
21 | .nf |
---|
22 | #include <mpi.h> |
---|
23 | bool MPI::Win::Test() const |
---|
24 | |
---|
25 | .SH INPUT PARAMETERS |
---|
26 | .ft R |
---|
27 | .TP 1i |
---|
28 | win |
---|
29 | Window object (handle) |
---|
30 | |
---|
31 | |
---|
32 | .SH OUTPUT PARAMETERS |
---|
33 | .ft R |
---|
34 | .TP 1i |
---|
35 | IERROR |
---|
36 | Fortran only: Error status (integer). |
---|
37 | .TP 1i |
---|
38 | flag |
---|
39 | The returning state of the test for epoch closure. |
---|
40 | |
---|
41 | |
---|
42 | .SH DESCRIPTION |
---|
43 | .ft R |
---|
44 | MPI_Win_test is a one-sided MPI communication synchronization call, a |
---|
45 | nonblocking version of MPI_Win_wait. It returns \fIag = true\fP if |
---|
46 | MPI_Win_wait would return, \fIag = false\fP otherwise. The effect of return of MPI_Win_test with \fIflag = true\fP is the same as the effect of a return of MPI_Win_wait. If \fIag = false\fP is returned, then the call has no visible effect. |
---|
47 | .sp |
---|
48 | Invoke MPI_Win_test only where MPI_Win_wait can be invoked. Once |
---|
49 | the call has returned \fIag = true\fP, it must not be invoked anew, until the window is posted anew. |
---|
50 | |
---|
51 | |
---|
52 | .SH ERRORS |
---|
53 | 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. |
---|
54 | .sp |
---|
55 | Before the error value is returned, the current MPI error handler is |
---|
56 | called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Win_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. |
---|
57 | |
---|
58 | .SH SEE ALSO |
---|
59 | MPI_Win_post |
---|
60 | MPI_Win_wait |
---|
61 | .br |
---|
62 | |
---|