Kolibri library – API Documentation

Header image

Main page


KolibriErr KOLIBRI_FUNC_ATTR kolibriProcess ( KolibriHandle  handle,
KolibriSint32  timeout 
)

Processes a registered list of datasets.

This function processes a list of datasets that has been registered with the Kolibri library. It will check if the data points described by the datasets should be triggered accoding to their trigger mode and will schedule transmission of their state when they are triggered. If a point is not triggered and its state has been written from the Broker, the state will be written to the variables linked through the dataset.
This function should be called regularly to synchronise data between the Kolibri library and the application. Data points cannot be triggered more often than this function is called.

Parameters
handleHendle returned by kolibriRegister()
timeoutMaximum time [ms] to wait for access to the library's internal data structures. Note that this does not equal the total execution time of the function.
Returns
Returns one of the following codes:
  • KOLIBRI_ERR_NO - Success
  • KOLIBRI_ERR_STATE - The library has not been initialised and started.
  • KOLIBRI_ERR_RESOURCE - Could not get exclusive access to the library's internal data structures within the given amount of time.
  • KOLIBRI_ERR_ARG - The given handle was invalid.
  • KOLIBRI_ERR_MEM - Could not allocate memory for the copy of a string or byte array value. Non-string and non-array values are not affected.
  • KOLIBRI_ERR_QUEUE - There were not enough free entries in the send queue. In case of an error you can check the err field of each dataset to check for specific error codes.
See also
kolibriRegister(), kolibriForce()
Reentrance
Yes (if malloc() and free() are reentrant)
Note
On Linux the system clock is used to measure the timeout. If the clock is set while waiting, the timeout may become shorter or longer.
Since
1.0.0





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated by Doxygen 1.8.10