MPI_Grequest_complete(3) Open MPI MPI_Grequest_complete(3)
NAME
MPI_Grequest_complete - Reports that a generalized request is com-
plete.
SYNTAX
C Syntax
#include <mpi.h>
int MPI_Grequest_complete(MPI_Request request)
Fortran Syntax
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_GREQUEST_COMPLETE(REQUEST, IERROR)
INTEGER REQUEST, IERROR
Fortran 2008 Syntax
USE mpi_f08
MPI_Grequest_complete(request, ierror)
TYPE(MPI_Request), INTENT(IN) :: request
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
C++ Syntax
#include <mpi.h>
void MPI::Grequest::Complete()
INPUT/OUTPUT PARAMETER
request Generalized request (handle).
OUTPUT PARAMETER
IERROR Fortran only: Error status (integer).
DESCRIPTION
MPI_Grequest_complete informs MPI that the operations represented by
the generalized request request are complete. A call to MPI_Wait(re-
quest, status) will return, and a call to MPI_Test(request, flag, sta-
tus) will return flag=true only after a call to MPI_Grequest_complete
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 MPI_Test, MPI_Re-
quest_free, or MPI_Cancel still hold. For example, all these calls are
supposed to be local and nonblocking. Therefore, the callback functions
query_fn, free_fn, or cancel_fn should invoke blocking MPI communica-
tion calls only if the context is such that these calls are guaranteed
to return in finite time. Once MPI_Cancel has been invoked, the can-
celed operation should complete in finite time, regardless of the state
of other processes (the operation has acquired "local" semantics). It
should either succeed or fail without side-effects. The user should
guarantee these same properties for newly defined operations.
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_Comm_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.
4.1.2 Nov 24, 2021 MPI_Grequest_complete(3)
Generated by dwww version 1.14 on Fri Jan 24 09:34:07 CET 2025.