MPI_TEST_CANCELLED, MPI_Test_cancelled

Purpose

Tests whether a nonblocking operation was cancelled.

C synopsis

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

C++ synopsis

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

FORTRAN synopsis

include 'mpif.h' or use mpi
MPI_TEST_CANCELLED(INTEGER STATUS(MPI_STATUS_SIZE),INTEGER FLAG,
    INTEGER IERROR)

Parameters

status
     is a status object (Status) (IN). Note that in FORTRAN a single status
     object is an array of integers.

flag
     true if the operation was cancelled (logical) (OUT)

IERROR
     is the FORTRAN return code. It is always the last argument.

Description

MPI_TEST_CANCELLED returns flag = true if the communication associated with
the status object was cancelled successfully. In this case, all other
fields of status (such as count or tag) are undefined. Otherwise, flag =
false is returned. If a receive operation might be cancelled, you should
call MPI_TEST_CANCELLED first to check if the operation was cancelled,
before checking on the other fields of the return status.

Notes

Nonblocking I/O operations are never cancelled successfully.

Errors

MPI not initialized

MPI already finalized

Related information