source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_Win_wait.3 @ 97

Last change on this file since 97 was 97, checked in by (none), 14 years ago

Adding compiled files

File size: 2.0 KB
Line 
1.\"Copyright 2007-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Win_wait 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Win_wait\fP \- Completes an RMA exposure epoch started by a call to MPI_Win_post on \fIwin\fP
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Win_wait(MPI_Win \fIwin\fP)
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17MPI_WIN_WAIT(\fI WIN, IERROR\fP)
18        INTEGER \fI WIN, IERROR\fP
19
20.SH C++ Syntax
21.nf
22#include <mpi.h>
23void MPI::Win::Wait() const
24
25.SH INPUT PARAMETERS
26.ft R
27.TP 1i
28win
29Window object (handle).
30
31.SH OUTPUT PARAMETERS
32.ft R
33.TP 1i
34IERROR
35Fortran only: Error status (integer).
36
37.SH DESCRIPTION
38.ft R
39MPI_Win_wait is a one-sided MPI communication synchronization call that completes an RMA exposure epoch started by a call to MPI_Win_post on \fIwin\fP. This
40call matches calls to MPI_Win_complete(\fIwin\fP) issued by each of the processes that
41were granted access to the window during this epoch. The call to MPI_Win_wait blocks
42until all matching calls to MPI_Win_complete have occurred. This guarantees that all
43these origin processes have completed their RMA accesses to the local window. When the
44call returns, all these RMA accesses will have completed at the target window.
45
46
47.SH ERRORS
48Almost 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
50Before the error value is returned, the current MPI error handler is
51called. 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.
52 
53.SH SEE ALSO
54MPI_Win_post
55.br
56
Note: See TracBrowser for help on using the repository browser.