User's Manual

SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide
Wavenet Technology 144 BM210012WT27

Register Event Callback Function
Since the RX events will be posted to private Receive MSMQ queues
the VDD is not required to support callback functions. Applications
can call the API function ‘nclReceiveData()’, to wait on response and
event messages from the RPM on their on account. The API function
‘nclReceiveData()’ will return within the time-out period specified, so
applications will not be hung-up indefinitely.

Enable / Disable Events
The application can call this function to enable or disable individual
event types being reported by the RPM. By default, only the Receive
Message Data event is enabled (NCL_RCV_MSG_DATA). All other
event types for an application are disabled unless they have been
specifically enabled / disabled using this function. The
NCL_RCV_MSG_NOTIF event is handled by the VDD, which will
post the received messages to all active RX queues (that have
NCL_RCV_MSG_DATA enabled) using the NCLRXDataID structure
type.
Prototype:
int nclSetEvent (word *usSduTag, byte ucType, byte ucSetting);
Description:
Enable / Disable event reporting by the RPM for the specified event
type.
Input:
 iSessionID VDD session ID
 usSduTag Pointer to a word where the SDU tag can be stored
 ucType The type of event to enable/disable:
NCL_RCV_MSG_DATA (Received message data)
NCL_TX_EVENT (Physical-level transmitter event)
NCL_RX_EVENT (Physical-level receiver event)
NCL_HW_EVENT (Hardware event)
NCL_RCV_ERR (Un-receivable message event)
NCL_CONTROL (Control event)
NCL_VEND_EVENT (Vendor specific event)
 ucSetting NCL_DISABLE (Disable event reporting)
NCL_ENABLE (Enable event reporting)
Output:
 Return value = 0 Operation was successful
 Return value ≠ 0 Operation failed. Value specifies the error type