Lockless Inc

NAME

MPI_Test_cancelled - Tests if a request was cancelled

SYNOPSIS

#include <mpi.h> int MPI_Test_cancelled(MPI_Status *status , int *flag );

#include <pmpi.h> int PMPI_Test_cancelled(MPI_Status *status , int *flag );

#include <mpi.h> bool MPI::Status::Is_cancelled(void) const;

INCLUDE 'mpif.h' MPI_TEST_CANCELLED(status , flag , ierr ) INTEGER status (MPI_STATUS_SIZE), flag , ierr

INPUT PARAMETER

status - request status (structure)

OUTPUT PARAMETER

flag - was the request cancelled? (boolean).

DESCRIPTION

The MPI_Test_cancelled() function is used to determine whether or not a request was cancelled. The status of a request has this information stored in the MPI_ERROR field of the MPI_Status structure. If this value is MPI_ERR_CANCEL then this function will set flag to one. Otherwise, flag will be set to zero.

The C++ version of this function passes the flag output as the return value.

PMPI_Test_cancelled() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.

MPI_SUCCESS - No error;

MPI_ERR_PENDING - Pending exception;

MPI_ERR_ARG - Invalid pointer.

SEE ALSO

MPI_Test (3) MPI_Wait (3) MPI_Cancel (3) MPI_Get_count (3) MPI_Get_elements (3)

About Us Returns Policy Privacy Policy Send us Feedback
Company Info | Product Index | Category Index | Help | Terms of Use
Copyright © Lockless Inc All Rights Reserved.