User Manual

4-18 Millennial Net
Using the MeshScape API
11. ibApi_WaitForDeviceEvent()
ibApi_FUNC ibApi_WaitForDeviceEvent(
ibApi_APIHANDLE api_hdl,
ibApi_DEVICEEVENTTYPEevent_types,
ibApi_INT32 timeout ms,
ibApi_DEVICEID * device_id
);
Note: This function is now obsolete and only retained for backward
compatibility. Please use ibApi_WaitForDeviceEvents() instead.
This function implements the simplest form of event notification using the application thread
content: It causes the calling thread to sleep until a network packet has arrived (i.e., the
sequence number has incremented), and then returns the ID of the device that was updated.
If multiple devices have changed since the last call, ibApi_WaitForDeviceEvent() will
return their ID’s in sequential round-robin order. If time timeout expires and nothing has
changed, the return value ibApi_RESULT_ERR_TIMEOUT.
Parameters:
api_hdl: (input) API handle returned from ibApi_Open().
event_types: (input) This parameter is reserved for a future feature allowing the wait
condition to be restricted to a subset of the possible event types. In the current release, the
parameter should always be ibApi_DEVICEEVENTTYPE_ALL.
timeout_ms: Number of milliseconds to wait before giving up (use -1 to wait indefinitely).
device_id: (output) ID of the device that changed.
Return Value:
An ibApi_RESULT_SUCCESS if a device changed, ibApi_RESULT_ERR_TIMEOUT if not, or an
error code (<0) if unsuccessful.