Elektra  0.9.7
Macros | Enumerations | Functions
kdbplugin.h File Reference

Methods for plugin programing. More...

#include <kdb.h>
#include <errno.h>
#include <kdbmacros.h>
#include <string.h>
Include dependency graph for kdbplugin.h:
This graph shows which files directly or indirectly include this file:

Macros

#define ELEKTRA_PLUGIN_FUNCTION(function)   ELEKTRA_PLUGIN_FUNCTION2 (ELEKTRA_PLUGIN_NAME_C, function)
 Declare a plugin's function name suitable for compilation variants (see doc/tutorials). More...
 
#define ELEKTRA_README   ELEKTRA_README2 (ELEKTRA_PLUGIN_NAME_C)
 The filename for inclusion of the readme for compilation variants (see doc/tutorials). More...
 
#define ELEKTRA_PLUGIN_STATUS_ERROR   -1
 An error occurred inside the plugin function.
 
#define ELEKTRA_PLUGIN_STATUS_SUCCESS   1
 Everything went fine.
 
#define ELEKTRA_PLUGIN_STATUS_NO_UPDATE   0
 Everything went fine and the function did not update the given keyset/configuration.
 
#define ELEKTRA_PLUGIN_STATUS_CACHE_HIT   2
 Everything went fine and we have a cache hit.
 

Enumerations

enum  plugin_t {
  ELEKTRA_PLUGIN_OPEN =1 , ELEKTRA_PLUGIN_CLOSE =1<<1 , ELEKTRA_PLUGIN_GET =1<<2 , ELEKTRA_PLUGIN_SET =1<<3 ,
  ELEKTRA_PLUGIN_ERROR =1<<4 , ELEKTRA_PLUGIN_COMMIT =1<<5 , ELEKTRA_PLUGIN_END =0
}
 Switches to denote the backend methods. More...
 

Functions

Plugin * elektraPluginExport (const char *pluginName,...)
 Allows one to Export Methods for a Plugin. More...
 
KeySet * elektraPluginGetConfig (Plugin *handle)
 Returns the configuration of that plugin. More...
 
void elektraPluginSetData (Plugin *plugin, void *handle)
 Store a pointer to plugin specific data. More...
 
void * elektraPluginGetData (Plugin *plugin)
 Get a pointer to the plugin specific data stored before. More...
 
KeySet * elektraPluginGetGlobalKeySet (Plugin *plugin)
 Get a pointer to the global keyset. More...
 

Detailed Description

Methods for plugin programing.

Enumeration Type Documentation

◆ plugin_t

enum plugin_t

Switches to denote the backend methods.

Used in calls to elektraPluginExport().

Enumerator
ELEKTRA_PLUGIN_OPEN 

Next arg is backend for kdbOpen()

ELEKTRA_PLUGIN_CLOSE 

Next arg is backend for kdbClose()

ELEKTRA_PLUGIN_GET 

Next arg is backend for kdbGet()

ELEKTRA_PLUGIN_SET 

Next arg is backend for kdbSet()

ELEKTRA_PLUGIN_ERROR 

Next arg is backend for kdbError()

ELEKTRA_PLUGIN_COMMIT 

Next arg is backend for kdbCommit()

ELEKTRA_PLUGIN_END 

End of arguments