mpiSynqNetEventNotifyGet

Declaration

MPI_RESULT
    mpiSynqNetEventNotifyGet(MPISynqNet          synqNet,
                             MPIEventMask        *eventMask,
                             MPIEventNotifyData  *eventNotifyData);

 

Required Header: stdmpi.h
Change History: Modified in 04.00.

Description

mpiSynqNetEventNotifyGet reads the event mask (that specifies the event types for the requested host notification) to the location pointed to by eventMask, and also writes the event notification structure (that specifies the event message controller addresses) to the location pointed to by eventNotifyData.

Use the event mask macros mpiEventMaskGET(...), mpiEventMaskBitGET(...), etc. to decode the eventMask.

synqNet A handle to a SynqNet object.
*eventMask Pointer to an event mask, whose bits are defined by the MPIEventType enumerations.
*eventNotifyData 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
MPIMessageARG_INVALID

Sample Code

/* Request notification of all events from SynqNet */
mpiEventMaskCLEAR(eventMask);

returnValue =
    mpiSynqNetEventNotifyGet(synqNet,
                             &eventMask,
                             NULL);

mpiEventMaskSYNQNET(eventMask);
	
if (returnValue == MPIMessageOK) {
    returnValue =
        mpiSynqNetEventNotifySet(synqNet,
                                 eventMask,
                                 NULL);
}

See Also

MPIEventType | MPIEventNotifyData