mpi_win_wait(3openmpi) [osx man page]

MPI_Win_wait(3OpenMPI)													    MPI_Win_wait(3OpenMPI)

NAME

       MPI_Win_wait - Completes an RMA exposure epoch started by a call to MPI_Win_post on win

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Win_wait(MPI_Win win)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_WIN_WAIT( WIN, IERROR)
	    INTEGER  WIN, IERROR

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

INPUT PARAMETERS

       win	 Window object (handle).

OUTPUT PARAMETERS

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       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 win. This call matches calls to MPI_Win_complete(win) 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.

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++ func-
       tions 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.

       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.

SEE ALSO

       MPI_Win_post

Open MPI 1.2							    March 2007						    MPI_Win_wait(3OpenMPI)

MPI_Win_wait(3) 							MPI							   MPI_Win_wait(3)

NAME

       MPI_Win_wait -  Completes an RMA exposure epoch begun with MPI_Win_post

SYNOPSIS

       int MPI_Win_wait(MPI_Win win)

INPUT PARAMETER

       win    - window object (handle)

THREAD AND INTERRUPT SAFETY

       This  routine  is  thread-safe.	This means that this routine may be safely used by multiple threads without the need for any user-provided
       thread locks.  However, the routine is not interrupt safe.  Typically, this is due to the use of memory allocation routines such as  malloc
       or other non-MPICH runtime routines that are themselves not interrupt-safe.

NOTES FOR FORTRAN

       All  MPI  routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument list.  ierr
       is an integer and has the same meaning as the return value of the routine in C.	In Fortran, MPI routines are subroutines, and are  invoked
       with the call statement.

       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran.

ERRORS

       All  MPI  routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the function and Fortran routines in
       the last argument.  Before the value is returned, the current MPI error handler is called.  By default, this error handler aborts  the  MPI
       job.   The  error  handler  may	be  changed  with  MPI_Comm_set_errhandler  (for  communicators), MPI_File_set_errhandler (for files), and
       MPI_Win_set_errhandler (for RMA windows).  The MPI-1 routine MPI_Errhandler_set may be used but its  use  is  deprecated.   The	predefined
       error handler MPI_ERRORS_RETURN may be used to cause error values to be returned.  Note that MPI does not guarentee that an MPI program can
       continue past an error; however, MPI implementations will attempt to continue whenever possible.

       MPI_SUCCESS
	      - No error; MPI routine completed successfully.
       MPI_ERR_WIN
	      - Invalid MPI window object
       MPI_ERR_OTHER
	      - Other error; use MPI_Error_string to get more information about this error code.

LOCATION

       win_wait.c

								     5/20/2010							   MPI_Win_wait(3)