Data Fields

_Plugin Struct Reference

#include <kdbprivate.h>

Collaboration diagram for _Plugin:
Collaboration graph
[legend]

Data Fields

KeySetconfig
kdbOpenPtr kdbOpen
kdbClosePtr kdbClose
kdbGetPtr kdbGet
kdbSetPtr kdbSet
kdbErrorPtr kdbError
const char * name
size_t refcounter
void * data

Detailed Description

Holds all information related to a plugin.

Since Elektra 0.8 a Backend consists of many plugins.

A plugin should be reusable and only implement a single concern. Plugins which are supplied with Elektra are located below src/plugins. It is no problem that plugins are developed external too.


Field Documentation

This keyset contains configuration for the plugin. Direct below system/ there is the configuration supplied for the backend. Direct below user/ there is the configuration supplied just for the plugin, which should be of course prefered to the backend configuration. The keys inside contain information like /path which path should be used to write configuration to or /host to which host packets should be send.

See also:
elektraPluginGetConfig()

This handle can be used for a plugin to store any data its want to.

kdbClosePtr _Plugin::kdbClose

The pointer to kdbClose_template() of the backend.

kdbErrorPtr _Plugin::kdbError

The pointer to kdbError_template() of the backend.

kdbGetPtr _Plugin::kdbGet

The pointer to kdbGet_template() of the backend.

kdbOpenPtr _Plugin::kdbOpen

The pointer to kdbOpen_template() of the backend.

kdbSetPtr _Plugin::kdbSet

The pointer to kdbSet_template() of the backend.

const char* _Plugin::name

The name of the module responsible for that plugin.

This refcounter shows how often the plugin is used. Not shared plugins have 1 in it


The documentation for this struct was generated from the following file: