Elektra Project: Elektra framework for pluggable backends

//
// This is my implementation for an Elektra backend storage.
//
// To compile it:
// $ cc -fpic -o myback.o -c myback.c
// $ cc -shared -fpic -o libelektra-myback.so myback.o
// 
// To use it:
// $ export KDB_BACKEND=myback
// $ kdb ls -Rv
//

#include <kdb.h>
#include <kdbbackend.h>

#define BACKENDNAME "my_elektra_backend_implementation"


int kdbOpen_backend() {...}
int kdbClose_backend() {...}
int kdbGetKey_backend(Key *key) {...}
int kdbSetKey_backend(Key *key) {...}

... etc implementations of other methods ...



KDBBackend *kdbBackendFactory(void) {
    return kdbBackendExport(BACKENDNAME,
        KDB_BE_OPEN,          &kdbOpen_backend,
        KDB_BE_CLOSE,         &kdbClose_backend,
        KDB_BE_GETKEY,        &kdbGetKey_backend,
        KDB_BE_SETKEY,        &kdbSetKey_backend,
        KDB_BE_STATKEY,       &kdbStatKey_backend,
        KDB_BE_RENAME,        &kdbRename_backend,
        KDB_BE_REMOVEKEY,     &kdbRemoveKey_backend,
        KDB_BE_GETCHILD,      &kdbGetKeyChildKeys_backend,
        KDB_BE_SETKEYS,       &kdbSetKeys_backend,
        KDB_BE_MONITORKEY,    &kdbMonitorKey_backend,
        KDB_BE_MONITORKEYS,   &kdbMonitorKeys_backend,
        KDB_BE_END);
}


Data Structures
struct	_Key
	The private Key struct. More...
struct	_KeySet
	The private KeySet struct. More...
Enumerations
enum	KDBBackendMethod { KDB_BE_OPEN = 1, KDB_BE_CLOSE = 1<<1, KDB_BE_STATKEY = 1<<2, KDB_BE_GETKEY = 1<<3, KDB_BE_SETKEY = 1<<4, KDB_BE_SETKEYS = 1<<5, KDB_BE_RENAME = 1<<6, KDB_BE_REMOVEKEY = 1<<7, KDB_BE_GETCHILD = 1<<8, KDB_BE_MONITORKEY = 1<<9, KDB_BE_MONITORKEYS = 1<<10, KDB_BE_END = 0 }
	Switches to denote the backend methods. More...
Functions
ssize_t	unencode (char encoded, void returned)
	Unencodes a buffer of ASCII hexadecimal values into a byte stream.
int	kdbNeedsUTF8Conversion ()
	Checks if UTF-8 conversion is needed in current context.
int	UTF8Engine (int direction, char *string, size_t inputOutputByteSize)
	Converts string to (`direction` = `UTF8_TO`) and from (`direction` = `UTF8_FROM`) UTF-8.
ssize_t	encode (void unencoded, size_t size, char returned)
	Encodes a buffer of data onto hexadecimal ASCII.
int	kdbSetKeys_default (KeySet *ks)
	A high level, probably inefficient implementation for the kdbSetKeys() method.
uint32_t	kdbMonitorKeys_default (KeySet *interests, uint32_t diffMask, unsigned long iterations, unsigned sleeptime)
	A high level, probably inefficient, implementation for the kdbMonitorKeys() method.
uint32_t	kdbMonitorKey_default (Key *interest, uint32_t diffMask, unsigned long iterations, unsigned sleeptime)
	A high level, probably inefficient, implementation for the kdbMonitorKey() method.
KDBBackend *	kdbBackendExport (const char *backendName,...)
	This function must be called by a backend's kdbBackendFactory() to define the backend's methods that will be exported.
size_t	strblen (const char *s)
	Calculates the lenght in bytes of a string.
int	kdbOpen_backend ()
	Initialize the backend.
int	kdbClose_backend ()
	All finalization logic of the backend should go here.
int	kdbStatKey_backend (Key *key)
	Implementation for kdbStatKey() method.
int	kdbGetKey_backend (Key *key)
	Implementation for kdbGetKey() method.
int	kdbSetKey_backend (Key *key)
	Implementation for kdbSetKey() method.
int	kdbRename_backend (Key key, const char newName)
	Implementation for kdbRename() method.
int	kdbRemoveKey_backend (const Key *key)
	Implementation for kdbRemoveKey() method.
ssize_t	kdbGetKeyChildKeys_backend (const Key parentKey, KeySet returned, unsigned long options)
	Implementation for kdbGetKeyChildKeys() method.
int	kdbSetKeys_backend (KeySet *ks)
	Implementation for kdbSetKeys() method.
uint32_t	kdbMonitorKeys_backend (KeySet *interests, uint32_t diffMask, unsigned long iterations, unsigned sleep)
	The implementation of this method is optional.
uint32_t	kdbMonitorKey_backend (Key *interest, uint32_t diffMask, unsigned long iterations, unsigned sleep)
	The implementation of this method is optional.
KDBBackend *	kdbBackendFactory (void)
	All KeyDB methods implemented by the backend can have random names, except kdbBackendFactory().

Elektra framework for pluggable backends

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation