gwenhywfar  5.11.1beta
Macros | Typedefs | Functions
configmgr.h File Reference
#include <gwenhywfar/inherit.h>
#include <gwenhywfar/db.h>
#include <gwenhywfar/stringlist.h>

Go to the source code of this file.

Macros

#define GWEN_CONFIGMGR_FOLDER   "configmgr"
 
#define GWEN_CONFIGMGR_PLUGIN_NAME   "configmgr"
 

Typedefs

typedef struct GWEN_CONFIGMGR GWEN_CONFIGMGR
 

Functions

GWENHYWFAR_API int GWEN_ConfigMgr_DeleteGroup (GWEN_CONFIGMGR *mgr, const char *groupName, const char *subGroupName)
 
GWENHYWFAR_API GWEN_CONFIGMGRGWEN_ConfigMgr_Factory (const char *url)
 
GWENHYWFAR_API void GWEN_ConfigMgr_free (GWEN_CONFIGMGR *mgr)
 
GWENHYWFAR_API int GWEN_ConfigMgr_GetGroup (GWEN_CONFIGMGR *mgr, const char *groupName, const char *subGroupName, GWEN_DB_NODE **pDb)
 
GWENHYWFAR_API int GWEN_ConfigMgr_GetUniqueId (GWEN_CONFIGMGR *mgr, const char *groupName, char *buffer, uint32_t bufferLen)
 
GWENHYWFAR_API int GWEN_ConfigMgr_HasGroup (GWEN_CONFIGMGR *mgr, const char *groupName, const char *subGroupName)
 
GWENHYWFAR_API int GWEN_ConfigMgr_ListGroups (GWEN_CONFIGMGR *mgr, GWEN_STRINGLIST *sl)
 
GWENHYWFAR_API int GWEN_ConfigMgr_ListSubGroups (GWEN_CONFIGMGR *mgr, const char *groupName, GWEN_STRINGLIST *sl)
 
GWENHYWFAR_API int GWEN_ConfigMgr_LockGroup (GWEN_CONFIGMGR *mgr, const char *groupName, const char *subGroupName)
 
GWENHYWFAR_API int GWEN_ConfigMgr_MkUniqueIdFromId (GWEN_CONFIGMGR *mgr, const char *groupName, uint32_t uid, int doCheck, char *buffer, uint32_t bufferLen)
 
GWENHYWFAR_API int GWEN_ConfigMgr_SetGroup (GWEN_CONFIGMGR *mgr, const char *groupName, const char *subGroupName, GWEN_DB_NODE *db)
 
GWENHYWFAR_API int GWEN_ConfigMgr_UnlockGroup (GWEN_CONFIGMGR *mgr, const char *groupName, const char *subGroupName)
 

Macro Definition Documentation

◆ GWEN_CONFIGMGR_FOLDER

#define GWEN_CONFIGMGR_FOLDER   "configmgr"

Definition at line 40 of file configmgr.h.

◆ GWEN_CONFIGMGR_PLUGIN_NAME

#define GWEN_CONFIGMGR_PLUGIN_NAME   "configmgr"

Definition at line 39 of file configmgr.h.

Typedef Documentation

◆ GWEN_CONFIGMGR

Definition at line 1 of file configmgr.h.

Function Documentation

◆ GWEN_ConfigMgr_DeleteGroup()

GWENHYWFAR_API int GWEN_ConfigMgr_DeleteGroup ( GWEN_CONFIGMGR mgr,
const char *  groupName,
const char *  subGroupName 
)

◆ GWEN_ConfigMgr_Factory()

GWENHYWFAR_API GWEN_CONFIGMGR* GWEN_ConfigMgr_Factory ( const char *  url)

Creates a GWEN_CONFIGMGR object. The given URL is inspected for the protocol part which is used to lookup the plugin responsible. A generic file based configuration manager might have the URL "dir://home/martin/testconfig" which means that all files of the configuration manager reside below the folder "/home/martin/testconfig". Other plugins might have another URL scheme, however, the protocol part always specifies the plugin (in this case "dir").

◆ GWEN_ConfigMgr_free()

GWENHYWFAR_API void GWEN_ConfigMgr_free ( GWEN_CONFIGMGR mgr)

◆ GWEN_ConfigMgr_GetGroup()

GWENHYWFAR_API int GWEN_ConfigMgr_GetGroup ( GWEN_CONFIGMGR mgr,
const char *  groupName,
const char *  subGroupName,
GWEN_DB_NODE **  pDb 
)

◆ GWEN_ConfigMgr_GetUniqueId()

GWENHYWFAR_API int GWEN_ConfigMgr_GetUniqueId ( GWEN_CONFIGMGR mgr,
const char *  groupName,
char *  buffer,
uint32_t  bufferLen 
)

◆ GWEN_ConfigMgr_HasGroup()

GWENHYWFAR_API int GWEN_ConfigMgr_HasGroup ( GWEN_CONFIGMGR mgr,
const char *  groupName,
const char *  subGroupName 
)

◆ GWEN_ConfigMgr_ListGroups()

GWENHYWFAR_API int GWEN_ConfigMgr_ListGroups ( GWEN_CONFIGMGR mgr,
GWEN_STRINGLIST sl 
)

◆ GWEN_ConfigMgr_ListSubGroups()

GWENHYWFAR_API int GWEN_ConfigMgr_ListSubGroups ( GWEN_CONFIGMGR mgr,
const char *  groupName,
GWEN_STRINGLIST sl 
)

◆ GWEN_ConfigMgr_LockGroup()

GWENHYWFAR_API int GWEN_ConfigMgr_LockGroup ( GWEN_CONFIGMGR mgr,
const char *  groupName,
const char *  subGroupName 
)

◆ GWEN_ConfigMgr_MkUniqueIdFromId()

GWENHYWFAR_API int GWEN_ConfigMgr_MkUniqueIdFromId ( GWEN_CONFIGMGR mgr,
const char *  groupName,
uint32_t  uid,
int  doCheck,
char *  buffer,
uint32_t  bufferLen 
)

Create an id which is unique inside the given group derived from the given id.

Returns
0 if okay, error code otherwise
Parameters
mgrpointer to config mgr object
groupNamename of the group within the id is unique
doCheckif !=0 the derived unique id MUST NOT exist
bufferbuffer to receive the generated unique id
bufferLensize of the buffer pointed to by "buffer" above

◆ GWEN_ConfigMgr_SetGroup()

GWENHYWFAR_API int GWEN_ConfigMgr_SetGroup ( GWEN_CONFIGMGR mgr,
const char *  groupName,
const char *  subGroupName,
GWEN_DB_NODE db 
)

◆ GWEN_ConfigMgr_UnlockGroup()

GWENHYWFAR_API int GWEN_ConfigMgr_UnlockGroup ( GWEN_CONFIGMGR mgr,
const char *  groupName,
const char *  subGroupName 
)