MPIGrequestcomplete(3OpenMPI) MPIGrequestcomplete(3OpenMPI)

NAME
       MMPPIIGGrreeqquueessttccoommpplleettee   -  Reports  that  a generalized request is com-
       plete.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIGrequestcomplete(MPIRequest request)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIGREQUESTCOMPLETE(REQUEST, IERROR)
            INTEGER   REQUEST, IERROR


CC++++ SSyynnttaaxx
       #include 
       void MPI::Grequest::Complete()


IINNPPUUTT//OOUUTTPPUUTT PPAARRAAMMEETTEERR
       request   Generalized request (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERR
       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPIGrequestcomplete informs MPI that the  operations  represented  by
       the   generalized   request   request   are   complete.   A   call   to
       MPIWait(request, status) will return, and a call to  MPITest(request,
       flag,  status)  will  return  flag=true  only  after a call to MPIGre-
       questcomplete has declared that these operations are complete.

       MPI imposes no restrictions on the code executed by the callback  func-
       tions.  However,  new  nonblocking operations should be defined so that
       the  general  semantic  rules  about  MPI  calls  such   as   MPITest,
       MPIRequestfree,  or  MPICancel  still  hold.  For example, all these
       calls are supposed to be local and nonblocking. Therefore, the callback
       functions  queryfn,  freefn,  or cancelfn should invoke blocking MPI
       communication calls only if the context is such that  these  calls  are
       guaranteed  to return in finite time. Once MPICancel has been invoked,
       the canceled operation should complete in finite  time,  regardless  of
       the state of other processes (the operation has acquired "local" seman-
       tics). It should either succeed or fail without side-effects. The  user
       should guarantee these same properties for newly defined operations.


EERRRROORRSS
       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::ERRORSTHROWEXCEPTIONS, 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
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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.





Open MPI 1.2                    September 2006 MPIGrequestcomplete(3OpenMPI)