 |
Elektra 0.11.0
|
|
Elektra 0.11.0
|
Notification feature. More...
Files | |
| file | kdbnotification.h |
| Elektra-Notification structures and declarations for application developers. | |
| file | kdbnotificationinternal.h |
| Elektra-Notification structures and declarations for developing notification and transport plugins. | |
Typedefs | |
| typedef void(* | ElektraNotificationConversionErrorCallback) (Key *key, void *context) |
| Callback function called when string to number conversion failed. More... | |
| typedef void(* | ElektraNotificationChangeCallback) (Key *key, void *context) |
| Callback function for key changes. More... | |
Functions | |
| int | elektraNotificationRegisterCallback (KDB *kdb, Key *key, ElektraNotificationChangeCallback callback, void *context) |
| Subscribe for updates via callback when a given key value is changed. More... | |
| int | elektraNotificationRegisterCallbackSameOrBelow (KDB *kdb, Key *key, ElektraNotificationChangeCallback callback, void *context) |
| Subscribe for updates via callback when a given key or a key below changed. More... | |
| int | elektraNotificationRegisterInt (KDB *kdb, Key *key, int *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterUnsignedInt (KDB *kdb, Key *key, unsigned int *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterLong (KDB *kdb, Key *key, long *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterUnsignedLong (KDB *kdb, Key *key, unsigned long *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterLongLong (KDB *kdb, Key *key, long long *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterUnsignedLongLong (KDB *kdb, Key *key, unsigned long long *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterFloat (KDB *kdb, Key *key, float *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterDouble (KDB *kdb, Key *key, double *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterKdbBoolean (KDB *kdb, Key *key, kdb_boolean_t *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterKdbChar (KDB *kdb, Key *key, kdb_char_t *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterKdbOctet (KDB *kdb, Key *key, kdb_octet_t *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterKdbShort (KDB *kdb, Key *key, kdb_short_t *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterKdbUnsignedShort (KDB *kdb, Key *key, kdb_unsigned_short_t *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterKdbLong (KDB *kdb, Key *key, kdb_long_t *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterKdbUnsignedLong (KDB *kdb, Key *key, kdb_unsigned_long_t *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterKdbLongLong (KDB *kdb, Key *key, kdb_long_long_t *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterKdbUnsignedLongLong (KDB *kdb, Key *key, kdb_unsigned_long_long_t *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterKdbFloat (KDB *kdb, Key *key, kdb_float_t *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterKdbDouble (KDB *kdb, Key *key, kdb_double_t *variable) |
| Subscribe for automatic updates to a given variable when the given key value is changed. More... | |
Notification feature.
For an introduction to notifications please see the Notification Tutorial.
Examples:
elektraNotificationContract() returns a contract for use with kdbOpen(). The contract ensures that the internalnotification plugin is registered into the correct hook and configured correctly.
Notification transport plugins (or simply transport plugins) need access to an I/O binding, as well as a notification callback and context.
All of these can be retrieved from the global keyset. The keys are as follows:
system:/elektra/io/binding Type: ElektraIoInterface *system:/elektra/notification/callback Type: ElektraNotificationCallbacksystem:/elektra/notification/context Type: ElektraNotificationCallbackContext *All of these keys are binary and store a pointer that can be read via *(TYPE **) keyValue (key).
The I/O binding can be accessed at any time. It is recommended, plugins read the key once during their open function and store the pointer in their plugin data struct.
The notification callback and context are provided by the internalnotification plugin. Since it might be initialised after the transport plugin, it is not recommended to read the callback and context in the open function. Instead the plugin should read and store the values when the first notification is processed.
Transport plugins should handle missing I/O bindings, notification callbacks and notification contexts gracefully. The plugin should not report and error and instead simply log a debug or warning message.
| typedef void(* ElektraNotificationChangeCallback) (Key *key, void *context) |
Callback function for key changes.
| key | changed key |
| context | user supplied callback context |
| typedef void(* ElektraNotificationConversionErrorCallback) (Key *key, void *context) |
Callback function called when string to number conversion failed.
| key | key with invalid value |
| context | user supplied callback context |
| int elektraNotificationRegisterCallback | ( | KDB * | kdb, |
| Key * | key, | ||
| ElektraNotificationChangeCallback | callback, | ||
| void * | context | ||
| ) |
Subscribe for updates via callback when a given key value is changed.
| handle | plugin handle |
| key | key to watch for changes |
| callback | callback function |
| context | user supplied context passed to callback function |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterCallbackSameOrBelow | ( | KDB * | kdb, |
| Key * | key, | ||
| ElektraNotificationChangeCallback | callback, | ||
| void * | context | ||
| ) |
Subscribe for updates via callback when a given key or a key below changed.
| handle | plugin handle |
| key | key to watch for changes |
| callback | callback function |
| context | user supplied context passed to callback function |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterDouble | ( | KDB * | kdb, |
| Key * | key, | ||
| double * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterFloat | ( | KDB * | kdb, |
| Key * | key, | ||
| float * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterInt | ( | KDB * | kdb, |
| Key * | key, | ||
| int * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
Subscribe for automatic updates to a given variable when the given key value is changed. On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterKdbBoolean | ( | KDB * | kdb, |
| Key * | key, | ||
| kdb_boolean_t * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterKdbChar | ( | KDB * | kdb, |
| Key * | key, | ||
| kdb_char_t * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterKdbDouble | ( | KDB * | kdb, |
| Key * | key, | ||
| kdb_double_t * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterKdbFloat | ( | KDB * | kdb, |
| Key * | key, | ||
| kdb_float_t * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterKdbLong | ( | KDB * | kdb, |
| Key * | key, | ||
| kdb_long_t * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterKdbLongLong | ( | KDB * | kdb, |
| Key * | key, | ||
| kdb_long_long_t * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterKdbOctet | ( | KDB * | kdb, |
| Key * | key, | ||
| kdb_octet_t * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterKdbShort | ( | KDB * | kdb, |
| Key * | key, | ||
| kdb_short_t * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterKdbUnsignedLong | ( | KDB * | kdb, |
| Key * | key, | ||
| kdb_unsigned_long_t * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterKdbUnsignedLongLong | ( | KDB * | kdb, |
| Key * | key, | ||
| kdb_unsigned_long_long_t * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterKdbUnsignedShort | ( | KDB * | kdb, |
| Key * | key, | ||
| kdb_unsigned_short_t * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterLong | ( | KDB * | kdb, |
| Key * | key, | ||
| long * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterLongLong | ( | KDB * | kdb, |
| Key * | key, | ||
| long long * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterUnsignedInt | ( | KDB * | kdb, |
| Key * | key, | ||
| unsigned int * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterUnsignedLong | ( | KDB * | kdb, |
| Key * | key, | ||
| unsigned long * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
| int elektraNotificationRegisterUnsignedLongLong | ( | KDB * | kdb, |
| Key * | key, | ||
| unsigned long long * | variable | ||
| ) |
Subscribe for automatic updates to a given variable when the given key value is changed.
On kdbGet iff the key is present and its content is valid, the registered variable is updated.
| handle | plugin handle |
| key | key to watch for changes |
| variable | variable |
| 1 | on success |
| 0 | on failure |
1.9.1