template.c

/***************************************************************************
            temaple.c  -  Skeleton of backends to access the Key Database
                             -------------------
    begin                : Mon Dec 26 2004
    copyright            : (C) 2004 by Avi Alkalay
    email                : avi@unix.sh
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the BSD License (revised).                      *
 *                                                                         *
 ***************************************************************************/



/***************************************************************************
 *                                                                         *
 *   This is the skeleton of the methods you'll have to implement in order *
 *   to provide libelektra.so a valid backend.                             *
 *   Simple fill the empty _backend functions with your code and you are   *
 *   ready to go.                                                          *
 *                                                                         *
 ***************************************************************************/


/* Subversion stuff

$Id: template.c 601 2006-02-15 02:32:13Z aviram $
$LastChangedBy: mraab $

*/



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


#define BACKENDNAME "my_backend"



#ifdef PATH_MAX
#define MAX_PATH_LENGTH PATH_MAX

#elif __USE_POSIX
#define MAX_PATH_LENGTH _POSIX_PATH_MAX
#else 
#define MAX_PATH_LENGTH 4096
#endif




int kdbOpen_backend() {
    /* backend initialization logic */
    return 0;
}




int kdbClose_backend() {
    /* free all backend resources and shut it down */
    return 0; /* success */
}



int kdbStatKey_backend(Key *key) {
    /* get the most possible key metainfo */
    return 0; /* success */
}


int kdbGetKey_backend(Key *key) {
    /* fully gets a key */
    return 0; /* success */
}



int kdbSetKey_backend(Key *key) {
    /* fully sets a key */
    return 0; /* success */
}



int kdbRename_backend(Key *key, const char *newName) {
    /* rename a key to another name */
    return 0; /* success */
}




int kdbRemoveKey_backend(const Key *key) {
    /* remove a key from the database */
    return 0;  /* success */
}




ssize_t kdbGetKeyChildKeys_backend(const Key *parentKey, KeySet *returned, unsigned long options) {
    /* retrieve multiple hierarchical keys */
    return returned->size; /* success */
}


int kdbSetKeys_backend(KeySet *ks) {
    /* set many keys */
    return 0;
}


uint32_t kdbMonitorKeys_backend(KeySet *interests, uint32_t diffMask,
        unsigned long iterations, unsigned sleep) {
    return 0;
}



uint32_t kdbMonitorKey_backend(Key *interest, uint32_t diffMask,
        unsigned long iterations, unsigned sleep) {
    return 0;
}


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_MONITORKEY,     &kdbMonitorKey_backend,
        KDB_BE_MONITORKEYS,    &kdbMonitorKeys_backend,
        /* set to default implementation: 
         * Don't set default. */
/*      KDB_BE_SETKEYS,        &kdbSetKeys_default,*/
        KDB_BE_END);
}

---