kdbnotificationinternal.h File Reference

Elektra-Notification structures and declarations for developing notification and transport plugins. More...

#include "kdb.h"
#include "kdbnotification.h"
#include "kdbplugin.h"

Include dependency graph for kdbnotificationinternal.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef int(*	ElektraNotificationPluginRegisterInt) (Plugin *handle, Key *key, int *variable)
	Subscribe for automatic updates to a given integer variable when the given key value is changed. More...
typedef int(*	ElektraNotificationPluginRegisterCallback) (Plugin *handle, Key *key, ElektraNotificationChangeCallback callback)
	Subscribe for updates via callback when a given key value is changed. 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(*	ElektraNotificationOpenNotification) (Plugin *handle, KeySet *parameters)
	Initialize plugin's notification capabilities. More...
typedef void(*	ElektraNotificationCloseNotification) (Plugin *handle, KeySet *parameters)
	Teardown plugin's notification capabilities. More...

Detailed Description

Elektra-Notification structures and declarations for developing notification and transport plugins.

Only used by elektra-notification library, notification plugins (e.g. internalnotification) and transport plugins.

Copyright

BSD License (see LICENSE.md or https://www.libelektra.org)

Typedef Documentation

ElektraNotificationCallback

typedef void(* ElektraNotificationCallback) (Key *key, ElektraNotificationCallbackContext *context)

Notify notification library of changes to a key.

This callback is passed by elektraNotificationOpen to plugins exporting a openNotification function.

Parameters

key	changed key
context	context passed by ElektraNotificationOpenNotification

ElektraNotificationCloseNotification

typedef void(* ElektraNotificationCloseNotification) (Plugin *handle, KeySet *parameters)

Teardown plugin's notification capabilities.

Exported as "closeNotification" by transport plugins.

Parameters

handle	plugin handle
parameters	unused

ElektraNotificationOpenNotification

typedef void(* ElektraNotificationOpenNotification) (Plugin *handle, KeySet *parameters)

Initialize plugin's notification capabilities.

Exported as "openNotification" by transport plugins.

Parameters

handle	plugin handle
parameters	contains the keys "/callback" (ElektraNotificationCallback * ) and "/context" (ElektraNotificationCallbackContext *).

ElektraNotificationPluginRegisterCallback

typedef int(* ElektraNotificationPluginRegisterCallback) (Plugin *handle, 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

ElektraNotificationPluginRegisterInt

typedef int(* ElektraNotificationPluginRegisterInt) (Plugin *handle, 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