mpiSqNodeEventNotifyGet
Declaration
MPI_RESULT mpiSqNodeEventNotifyGet(MPISqNode node, MPIEventMask *eventMask, MPIEventNotifyData *eventNotifyData);
Required Header: stdmpi.h
Change History: Modified in 04.00.
Description
mpiSqNodeEventNotifyGet reads the event mask (that specifies the event types for which host notification has been requested) 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.
| node | A handle to a SynqNet node object |
|---|---|
| *eventMask | Pointer to an event mask, whose bits are defined by the MPIEventType enumerations. |
| *eventNotifyData | Pointer to an event notification data structure, which contains 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 SqNode */
mpiEventMaskCLEAR(eventMask);
returnValue =
mpiSqNodeEventNotifyGet(node,
&eventMask,
NULL);
mpiEventMaskSQNODE(eventMask);
if (returnValue == MPIMessageOK) {
returnValue =
mpiSqNodeEventNotifySet(node,
eventMask,
NULL);
}