Elektra-Notification structures and declarations for application developers. More...
#include "kdb.h"
Include dependency graph for kdbnotification.h:
This graph shows which files directly or indirectly include this file:
Typedefs | |
| typedef void(* | ElektraNotificationChangeCallback) (Key *key) |
| Callback function for key changes. More... | |
Functions | |
| int | elektraNotificationOpen (KDB *kdb) |
| Initialize the notification system for the given KDB instance. More... | |
| int | elektraNotificationClose (KDB *kdb) |
| Stop the notification system for the given KDB instance. More... | |
| int | elektraNotificationRegisterInt (KDB *kdb, Key *key, int *variable) |
| Subscribe for automatic updates to a given integer variable when the given key value is changed. More... | |
| int | elektraNotificationRegisterCallback (KDB *kdb, Key *key, ElektraNotificationChangeCallback callback) |
| Subscribe for updates via callback when a given key value is changed. More... | |
Detailed Description
Elektra-Notification structures and declarations for application developers.
- Copyright
- BSD License (see LICENSE.md or https://www.libelektra.org)
Typedef Documentation
◆ ElektraNotificationChangeCallback
| typedef void(* ElektraNotificationChangeCallback) (Key *key) |
Callback function for key changes.
- Parameters
-
key changed key
Function Documentation
◆ elektraNotificationClose()
| int elektraNotificationClose | ( | KDB * | kdb | ) |
Stop the notification system for the given KDB instance.
May only be called after elektraNotificationOpen() was called for given KDB instance.
- Parameters
-
kdb KDB instance
- Return values
-
1 on success 0 on error
◆ elektraNotificationOpen()
| int elektraNotificationOpen | ( | KDB * | kdb | ) |
Initialize the notification system for the given KDB instance.
May only be called once for a KDB instance. Subsequent calls return 0.
- Parameters
-
kdb KDB instance
- Return values
-
1 on success 0 on error
◆ elektraNotificationRegisterCallback()
| int elektraNotificationRegisterCallback | ( | KDB * | kdb, |
| Key * | key, | ||
| ElektraNotificationChangeCallback | callback | ||
| ) |
Subscribe for updates via callback when a given key value is changed.
- Parameters
-
handle plugin handle key key to watch for changes callback callback function
- Return values
-
1 on success 0 on failure
◆ elektraNotificationRegisterInt()
| int elektraNotificationRegisterInt | ( | KDB * | kdb, |
| Key * | key, | ||
| int * | variable | ||
| ) |
Subscribe for automatic updates to a given integer variable when the given key value is changed.
- Parameters
-
handle plugin handle key key to watch for changes variable integer variable
- Return values
-
1 on success 0 on failure
