mpiRecorderEventNotifySet

Declaration

long mpiRecorderEventNotifySet(MPIRecorder   recorder,
                               MPIEventMask  eventMask,
                               void          *external) 

Description

mpiRecorderEventNotifySet requests host notification of the event(s) specified by eventMask and generated by a Recorder (recorder), and also generated by the implementation-specific structure pointed to by external (if external is not NULL).

The events in external are in addition to the events in recorder, i.e, the events in recorder and in external are not necessarily the same events. Note that recorder or external can be NULL (but not both NULL).

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 MEIEventType.

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.

Remarks

external either points to a structure of type MEIEventNotifyData{} or is NULL. An MEIEventNotifyData{} structure is an array of firmware addresses. The contents of these firmware addresses are placed into the MEIEventStatusInfo{} structure (which contains all events generated by this Recorder object).

See Also

MEIEventMaskRECORDER | MEIEventNotifyData | MEIEventStatusInfo
mpiRecorderEventNotifyGet