Kolibri library – API Documentation

Header image

Main page

KolibriErr KOLIBRI_FUNC_ATTR kolibriForce ( KolibriHandle  handle,
KolibriUint16  datasetIdx,
KolibriSint32  timeout 

Forces transmission of a registered dataset.

This function forces one dataset inside a registered list of datasets to be transmitted to the Broker ignoring the trigger mode and parameters of the corresponding data point.

handleHendle returned by kolibriRegister()
datasetIdxIndex of the dataset inside the dataset list
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 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 or index was invalid.
  • KOLIBRI_ERR_DATASET - The given handle and index do not reference a valid and active data point.
  • 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 was no free entry 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(), kolibriProcess()
Yes (if malloc() and free() are reentrant)
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.

Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated by Doxygen 1.8.10