Edit

Share via


MPI_Grequest_cancel_function callback function

MPI_Grequest_cancel_function is a placeholder for the application-defined function name.

Syntax

int MPI_Grequest_cancel_function(
  _In_opt_ void *extra_state,
           int  complete
);

Parameters

  • extra_state [in, optional]
    Extra state.

  • complete
    MPI passes complete=true to the callback function if MPI_Grequest_complete was already called on the request, and complete=false otherwise.

Return value

All callback functions return an error code. The code is passed back and dealt with as appropriate for the error code by the MPI function that invoked the callback function.

Fortran

    SUBROUTINE GREQUEST_CANCEL_FUNCTION(EXTRA_STATE, COMPLETE, IERROR)
        INTEGER IERROR
        INTEGER(KIND=MPI_ADDRESS_KIND) EXTRA_STATE
        LOGICAL COMPLETE

Remarks

The the application-defined function with this signature is invoked to start the cancelation of a generalized request. It is called by MPI_Cancel.

Requirements

Product

HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities

Header

Mpi.h; Mpif.h

See also

MPI External Functions

MPI_Grequest_start