$darkmode
Elektra 0.11.0
|
Elektra-Notification structures and declarations for developing notification and transport plugins. More...
Typedefs | |
typedef int(* | ElektraNotificationPluginRegisterCallback) (Plugin *handle, Key *key, ElektraNotificationChangeCallback callback, void *context) |
Subscribe for updates via callback when a given key value is changed. More... | |
typedef int(* | ElektraNotificationPluginRegisterCallbackSameOrBelow) (Plugin *handle, Key *key, ElektraNotificationChangeCallback callback, void *context) |
Subscribe for updates via callback when a given key or a key below is changed. More... | |
typedef void(* | ElektraNotificationSetConversionErrorCallback) (Plugin *handle, ElektraNotificationConversionErrorCallback callback, void *context) |
Allow setting a callback that is called when a value conversion failed. More... | |
typedef struct _ElektraNotificationCallbackContext | ElektraNotificationCallbackContext |
Context for notification callbacks. | |
typedef void(* | ElektraNotificationCallback) (Key *key, ElektraNotificationCallbackContext *context) |
Notify notification library of changes to a key. More... | |
typedef void(* | ElektraNotificationKdbUpdate) (KDB *kdb, Key *changedKey) |
Used by notification plugins to get values from the key database. More... | |
Elektra-Notification structures and declarations for developing notification and transport plugins.
Only available in Elektra's source.
Only used by elektra-notification library, notification plugins (e.g. internalnotification) and transport plugins.
typedef void(* ElektraNotificationCallback) (Key *key, ElektraNotificationCallbackContext *context) |
Notify notification library of changes to a key.
This callback is provided by the internalnotification
plugin and for use by notification transport plugins.
key | changed key |
context | additional data |
typedef void(* ElektraNotificationKdbUpdate) (KDB *kdb, Key *changedKey) |
Used by notification plugins to get values from the key database.
kdb | kdb handle |
changedKey | which key was updated |
typedef int(* ElektraNotificationPluginRegisterCallback) (Plugin *handle, Key *key, ElektraNotificationChangeCallback callback, void *context) |
Subscribe for updates via callback when a given key value is changed.
Exported as "registerCallback" by notification plugins.
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 |
typedef int(* ElektraNotificationPluginRegisterCallbackSameOrBelow) (Plugin *handle, Key *key, ElektraNotificationChangeCallback callback, void *context) |
Subscribe for updates via callback when a given key or a key below is changed.
Exported as "registerCallbackSameOrBelow" by notification plugins.
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 |
typedef void(* ElektraNotificationSetConversionErrorCallback) (Plugin *handle, ElektraNotificationConversionErrorCallback callback, void *context) |
Allow setting a callback that is called when a value conversion failed.
Exported as "setConversionErrorCallback" notification plugins.
kdb | kdb handle |
callback | callback |
context | context |