Kolibri library – API Documentation

Header image

Main page


Macros
Kolibri constants

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

Macros

#define KOLIBRI_VERSION
 Kolibri library version. More...
 
#define KOLIBRI_MAX_STR_LEN   4096
 Maximum length of a string. More...
 
#define KOLIBRI_MAX_BYTE_ARRAY_LEN   4096
 Maximum length of a byte array. More...
 
#define KOLIBRI_INVALID_IDX   ((KolibriUint16)-1)
 Indicates an invalid point or group index. More...
 
#define KOLIBRI_INVALID_HANDLE   NULL
 Indicates an invalid datasets handle. More...
 
#define KOLIBRI_MAX_HOST_LEN   256
 Maximum length of a host string. More...
 
#define KOLIBRI_MAX_PROJECT_LEN   32
 Maximum length of a project name string. More...
 
#define KOLIBRI_MAX_PRODUCER_LEN   32
 Maximum length of a produceer name string. More...
 
#define KOLIBRI_MAX_USER_LEN   32
 Maximum length of a user name string. More...
 
#define KOLIBRI_MIN_KEEP_ALIVE_INTERVAL   15
 Minimum keep-alive interval. More...
 
#define KOLIBRI_PASS_HASH_SIZE   20
 Size of the password storage hash. More...
 
#define KOLIBRI_DEFAULT_TIMEOUT   30000UL
 Default communication timeout value [ms]. More...
 
#define KOLIBRI_DEFAULT_TX_QUEUE_SIZE   50
 Default TX queue size. More...
 
#define KOLIBRI_DEFAULT_RX_QUEUE_SIZE   50
 Default RX queue size. More...
 
#define KOLIBRI_DEFAULT_MAX_N_DATASET_LISTS   10
 Default maximum number of dataset lists. More...
 
#define KOLIBRI_DEFAULT_RPC_CLIENT_QUEUE_SIZE   5
 Default RPC client queue size. More...
 
#define KOLIBRI_DEFAULT_TASK_PRIO   20
 Default task priority. More...
 
#define KOLIBRI_DEFAULT_TASK_SLEEP_TIME   10
 Default task sleep time [ms]. More...
 
#define KOLIBRI_DEFAULT_KEEP_ALIVE_INTERVAL   300
 Default keep-alive interval [s]. More...
 
#define KOLIBRI_DEFAULT_KEEP_ALIVE_TIMEOUT   40
 Default keep-alive timeout [s]. More...
 
#define KOLIBRI_DEFAULT_RPC_SERVER_QUEUE_SIZE   5
 Default RPC server queue size. More...
 
#define KOLIBRI_DEFAULT_RPC_SERVER_TASK_PRIO   21
 Default RPC server task priority. More...
 
#define KOLIBRI_DEFAULT_RPC_SERVER_TASK_SLEEP_TIME   100
 Default RPC server task sleep time [ms]. More...
 
#define KOLIBRI_DEFAULT_RPC_SERVER_TASK_STACK_SIZE   8192
 Default RPC server task's stack size. More...
 
#define KOLIBRI_RPC_ERR_CODE_BASE   -31900
 Positive error codes from KolibriErr can be subtracted from this value to translate them to JSON-RPC error codes. More...
 

Detailed Description

Documentation of constants defined by the Kolibri library.






Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated by Doxygen 1.8.10