mpi_win_wait.3

MPI stands for the Message Passing Interface. Written by the MPI Forum (a large committee comprising

.\"Copyright 2007, Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.TH MPI_Win_wait 3OpenMPI "March 2007" "Open MPI 1.2" " "
.SH NAME
\fBMPI_Win_wait\fP \- Completes an RMA exposure epoch started by a call to MPI_Win_post on \fIwin\fP

.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Win_wait(MPI_Win \fIwin\fP)

.SH Fortran Syntax
.nf
INCLUDE 'mpif.h'
MPI_WIN_WAIT(\fI WIN, IERROR\fP)
	INTEGER \fI WIN, IERROR\fP

.SH C++ Syntax
.nf
#include <mpi.h>
void MPI::Win::Wait() const 

.SH INPUT PARAMETERS
.ft R
.TP 1i
win
Window object (handle).

.SH OUTPUT PARAMETERS
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer). 

.SH DESCRIPTION
.ft R
MPI_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
call matches calls to MPI_Win_complete(\fIwin\fP) issued by each of the processes that
were granted access to the window during this epoch. The call to MPI_Win_wait blocks
until all matching calls to MPI_Win_complete have occurred. This guarantees that all
these origin processes have completed their RMA accesses to the local window. When the
call returns, all these RMA accesses will have completed at the target window.


.SH ERRORS
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.
.sp
Before the error value is returned, the current MPI error handler is
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. 
 
.SH SEE ALSO
MPI_Win_post
.br

' @(#)MPI_Win_wait.3 1.7 06/03/09