Kolibri library – API Documentation

Header image

Main page


Functions
Kolibri functions

Documentation of functions defined by the Kolibri library. More...

Functions

KolibriUint32 KOLIBRI_FUNC_ATTR kolibriGetVersion (void)
 Returns the version of the Kolibri library. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriGeneratePassHash (KolibriUint8 *passHash, char const *pass, char const *user, char const *project)
 Generate password hash. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriInit (char const *project, char const *host, char const *producer, char const *user, KolibriUint8 const *passHash)
 Initialise. More...
 
void KOLIBRI_FUNC_ATTR kolibriDeinit (void)
 De-initialise. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriSetTaskPrio (int prio, KolibriUint16 sleepTime)
 Set task priority. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriSetWatchdogManager (KolibriUint32 period)
 Set watchdog manager. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriSetPort (KolibriUint16 port)
 Set port. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriSetTimeout (KolibriUint32 timeout)
 Set communication timeout. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriSetKeepAlive (KolibriUint16 interval, KolibriUint8 timeout)
 Set keep-alive timing parameters. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriDisableTls (void)
 Disable SSL/TLS. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriSetTlsContext (void *context)
 Set SSL/TLS context. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriSetQueueSizes (unsigned txQueueSize, unsigned rxQueueSize, unsigned maxNDatasetLists, unsigned rpcClientQueueSize)
 Set queue sizes and maximum number of dataset lists. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriRegisterClockUpdateCb (KolibriClockUpdateCb cb)
 Register clock update callback. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriRegisterLogCb (KolibriLogCb cb, char const *msgPrefix, KolibriLogOpt opts)
 Registers a call-back function for logging. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriRegisterPublishCb (KolibriPublishCb cb)
 Registers a call-back function for (un-)publishing. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriRegisterPublishCompleteCb (KolibriPublishCompleteCb cb)
 Registers a call-back function for (un-)publishing complete. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriRegisterTrafficCb (KolibriTrafficCb cb)
 Registers a traffic call-back function. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriStart (void)
 Start the library. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriClockUpdate (void)
 Notifies about system clock update. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriRegister (KolibriHandle *handle, KolibriDataset *datasetList, unsigned nDatasets)
 Register. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriDeregister (KolibriHandle handle)
 De-register. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriProcess (KolibriHandle handle, KolibriSint32 timeout)
 Processes a registered list of datasets. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriForce (KolibriHandle handle, KolibriUint16 datasetIdx, KolibriSint32 timeout)
 Forces transmission of a registered dataset. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriGetState (KolibriState *state)
 Gets the state of the Kolibri library. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriGetLastCommErr (void)
 Gets the last communication error. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriGetStats (KolibriStats *stats)
 Gets statistical data. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriCreateNode (char const *path, KolibriNodeType nodeType, KolibriCreateModifyNodeOpts opts, KolibriNodeProps const *props)
 Creates a node. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriModifyNode (char const *path, KolibriNodeType nodeType, KolibriCreateModifyNodeOpts opts, KolibriNodeProps const *props)
 Modifies a node's properties. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriDeleteNode (char const *path)
 Deletes a node. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriGetNodeProps (char const *path, KolibriNodeType *nodeType, KolibriNodeProps *props)
 Gets a node's properties. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriGetNodeList (char const ***paths, unsigned *n)
 Gets the list of all nodes. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriGetNodeListDone (void)
 Frees internal data structures created by kolibriGetNodeList() More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriCallRpc (json::Base **response, char const *server, char const *method, json::Obj *params)
 Invokes a remote procedure call. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriInitRpcServer (unsigned maxNMethods)
 Initialises the RPC server. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriSetRpcServerQueueSize (unsigned size)
 Sets the queue size of the RPC server. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriDisallowRpcServerReboot ()
 Disallows reboot to be triggered via the RPC method kolibri.reboot() More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriSetRpcServerTaskPrio (int prio, KolibriUint16 sleepTime)
 Sets the priority of the RPC server task. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriSetRpcServerTaskStackSize (unsigned size)
 Sets the size of the RPC server task's stack. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriSetRpcServerWatchdogManager (KolibriUint32 period)
 Set watchdog manager of the RPC server task. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriAddRpcServerMethod (char const *name, KolibriRpcServerCb cb, void *context)
 Adds a method to the RPC server. More...
 
KolibriErr KOLIBRI_FUNC_ATTR kolibriRemoveRpcServerMethod (char const *name)
 Removes a method from the RPC server. More...
 

Detailed Description

Documentation of functions defined by the Kolibri library.






Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated by Doxygen 1.8.10