Synopsis
int MPI_T_event_set_dropped_handler(MPI_T_event_registration event_registration,
MPI_T_event_dropped_cb_function dropped_cb_function)
Input Parameters
- event_registration
-
valid event registration (handle)
- dropped_cb_function
-
pointer to user-defined callback function (function)
Description
MPI_T_event_set_dropped_handler registers a callback function to be invoked when event information is dropped for a specified event-registration handle.
This routine has local semantics. Subsequent calls with the same registration handle replace previously-registered callback functions for that handle. If dropped_cb_function is NULL, no data loss is recorded or reported until a new valid callback function is registered. The invocation of the dropped handler callback function may not necessarily occur close to the time the event was actually lost.
Thread and Interrupt Safety
This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.
Errors
All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with 'MPI_Comm_set_errhandler' (for communicators),
'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for
RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but
its use is deprecated. 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; however, MPI implementations will attempt to continue whenever
possible.
-
MPI_SUCCESS - No error; MPI routine completed successfully.
-
MPI_T_ERR_INVALID_HANDLE - The handle is invalid.
-
MPI_T_ERR_NOT_INITIALIZED - The MPI tool information interface is not initialized.
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.