mpi_test_cancelled(3openmpi) [osx man page]

MPI_Test_cancelled(3OpenMPI)											      MPI_Test_cancelled(3OpenMPI)

NAME

       MPI_Test_cancelled - Tests whether a request was canceled.

SYNTAX

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

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_TEST_CANCELLED(STATUS, FLAG, IERROR)
	    LOGICAL   FLAG
	    INTEGER   STATUS(MPI_STATUS_SIZE), IERROR

C++ Syntax
       #include <mpi.h>
       bool Status::Is_cancelled() const

INPUT PARAMETER

       status	 Status object (status).

OUTPUT PARAMETERS

       flag	 True if operation was cancelled (logical).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

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

NOTES

       Cancel can be an expensive operation that should be used only exceptionally.

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.

Open MPI 1.2							  September 2006				      MPI_Test_cancelled(3OpenMPI)

Check Out this Related Man Page

MPI_Is_thread_main(3OpenMPI)											      MPI_Is_thread_main(3OpenMPI)

NAME

       MPI_Is_thread_main - Determines if thread called MPI_Init

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Is_thread_main(int *flag)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_IS_THREAD_MAIN(FLAG, IERROR)
	    LOGICAL   FLAG
	    INTEGER   IERROR

C++ Syntax
       #include <mpi.h>
       bool MPI::Is_thread_main()

OUTPUT PARAMETERS

       flag	 True if calling thread is main thread (boolean).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_Is_thread_main  is  called  by  a thread to find out whether the caller is the main thread (that is, the thread that called MPI_Init or
       MPI_Init_thread).

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.

       See the MPI man page for a full list of MPI error codes.

SEE ALSO

       MPI_Init
       MPI_Init_thread

Open MPI 1.2							  September 2006				      MPI_Is_thread_main(3OpenMPI)

Linux and UNIX Man Pages

mpi_test_cancelled(3openmpi) [osx man page]

Check Out this Related Man Page