mpiRecorderEventNotifySet

Declaration

MPI_RESULT
   mpiRecorderEventNotifySet(MPIRecorder                recorder,
                             const MPIEventMask         eventMask,
                             const MPIEventNotifyData   *eventNotifyData);

Required Header: stdmpi.h

Description

mpiRecorderEventNotifySet requests host notification of the event(s) specified by eventMask and generated by a Recorder (recorder), and also specified by the event notification structure (that specifies the event message controller addresses) to the location pointed to by eventNotifyData.

Event notification is enabled for the event types specified in eventMask. eventMask is a bit mask generated by the logical OR of the MPIEventMask bits that are associated with the desired MPIEventType values. Event notification is disabled for event types not specified in eventMask.

The mask of event types (generated by a Recorder object) consists of MPIEventMaskRECORDER_HIGH, MPIEventMaskRECORDER_FULL and MPIEventMaskRECORDER_DONE. For more detail, see MPIEventType.

If recorder is set to record continuously in mpiRecorderStart, and bufferWrap is set to TRUE in MPIRecorderConfig, only MPIEventTypeRECORDER_FULL will be generated. Recorder events MPIEventTypeRECORDER_FULL and MPIEventTypeRECORDER_DONE will not be generated.

recorder	A handle to a Recorder object.
eventMask	An event mask, whose bits are defined by the MPIEventType enumeration.
*eventNotifyData	A pointer to an event notification data structure, containing a list of controller addresses. The event data specified by the addresses is copied into the event message by the controller.

Return Values
MPIMessageOK

mpiRecorderEventNotifySet

Declaration

Description

See Also