Kolibri library – API Documentation

Header image

Main page


Log options.

The constants from this enumeration type can be used to configure what messages should be logged. The constants can be ored to build the options bitmap that is passed to kolibriRegisterLogCb().

See also
kolibriRegisterLogCb
Since
1.1.0
Last functional change:
2.1.0 Added options KOLIBRI_LOG_OPT_ERR and KOLIBRI_LOG_OPT_WARN
Enumerator
KOLIBRI_LOG_OPT_CONN_LOGIN 

If this option is set, general information concerning the connection and login to the Broker will be logged (connection established, connection closed, logged in, connection error reasons, login error reasons, keep-alive timeouts etc.).
It is recommended to enable this option in normal operation.

KOLIBRI_LOG_OPT_CLOCK 

If this option is set, general information concerning clock synchronisation with the Broker will be logged (clock synchronised, synchronisation error reasons etc.).
It is recommended to enable this option in normal operation.

KOLIBRI_LOG_OPT_TX_VALS 

If this option is set, detailed information concerning the transmission of values to the Broker will be logged (value added to the queue, queue full, write/commit command send/acknowledged, communication errors, protocol errors etc.).
It is recommended to enable this option to debug transmission of values to the Broker.

KOLIBRI_LOG_OPT_RX_VALS 

If this option is set, detailed information concerning the reception of values from the Broker will be logged (value received/committed, communication errors, protocol errors, queue full, value assigned to point, value passed to application etc.).
It is recommended to enable this option to debug reception of values from the Broker.

KOLIBRI_LOG_OPT_PUBLISH 

If this option is set, detailed information concerning the (un-)publishing of nodes by the Broker will be logged (point/group (un-)published, communication errors, protocol errors, point assigned to dataset etc.).
It is recommended to enable this option to debug (un-)publishing of nodes.

KOLIBRI_LOG_OPT_NODE_MANIP 

If this option is set, detailed information concerning node manipulation commands (create node, modify node, delete node, get node properties, get node list) will be logged (Transmission of commands, communication errors, protocol errors etc.).
It is recommended to enable this option to debug node manipulation commands.

KOLIBRI_LOG_OPT_RPC 

If this option is set, detailed information concerning RPCs will be logged (Invokation of methods, transmission/reception of requests/results/error objects, communication errors, parsing errors).
It is recommended to enable this option to debug RPCs.

KOLIBRI_LOG_OPT_EMCY 

If this option is set, detailed information concerning emergencies will be logged (transmission, acknowledgement, communication errors etc.).
It is recommended to enable this option to debug emergencies.

KOLIBRI_LOG_OPT_PROTO 

If this option is set, detailed information concerning the Kolibri protocol will be logged that are not covered by any other option (Reception of any frame, invalid sequence numbers, invalid opcodes, unmatched Acks/Naks, protocol errors etc.).
It is recommended to enable this option to debug the Kolibri protocol.

KOLIBRI_LOG_OPT_ERR 

If this option is set, any error or fatal error will be logged. While most other options include any messages concerning a certain topic, this option includes only error and fatal error messages concerning any topic.
It is recommended to enable this option in normal operation.

KOLIBRI_LOG_OPT_WARN 

If this option is set, any warning will be logged. While most other options include any messages concerning a certain topic, this option includes only warning messages concerning any topic.
It is recommended to enable this option in normal operation, if you want to provide higher verbosity.






Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated by Doxygen 1.8.10