le_cfg_interface.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */

#ifndef LE_CFG_INTERFACE_H_INCLUDE_GUARD
#define LE_CFG_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_DisconnectService
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_cfg_Iterator* le_cfg_IteratorRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_CFG_TYPE_EMPTY,

    LE_CFG_TYPE_STRING,

    LE_CFG_TYPE_BOOL,

    LE_CFG_TYPE_INT,

    LE_CFG_TYPE_FLOAT,

    LE_CFG_TYPE_STEM,

    LE_CFG_TYPE_DOESNT_EXIST
}
le_cfg_nodeType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_CFG_STR_LEN 511


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_CFG_STR_LEN_BYTES 512


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_CFG_NAME_LEN 63


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_CFG_NAME_LEN_BYTES 64


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_cfg_ChangeHandler* le_cfg_ChangeHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_cfg_ChangeHandlerFunc_t)
(
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_cfg_IteratorRef_t le_cfg_CreateReadTxn
(
    const char* basePath
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_cfg_IteratorRef_t le_cfg_CreateWriteTxn
(
    const char* basePath
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_CommitTxn
(
    le_cfg_IteratorRef_t iteratorRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_CancelTxn
(
    le_cfg_IteratorRef_t iteratorRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_GoToNode
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* newPath
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_GoToParent
(
    le_cfg_IteratorRef_t iteratorRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_GoToFirstChild
(
    le_cfg_IteratorRef_t iteratorRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_GoToNextSibling
(
    le_cfg_IteratorRef_t iteratorRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_GetPath
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path,

    char* pathBuffer,

    size_t pathBufferNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_cfg_nodeType_t le_cfg_GetNodeType
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_GetNodeName
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path,

    char* name,

    size_t nameNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_cfg_ChangeHandlerRef_t le_cfg_AddChangeHandler
(
    const char* newPath,

    le_cfg_ChangeHandlerFunc_t handlerPtr,

    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_RemoveChangeHandler
(
    le_cfg_ChangeHandlerRef_t addHandlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_DeleteNode
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_cfg_IsEmpty
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_SetEmpty
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_cfg_NodeExists
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_GetString
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path,

    char* value,

    size_t valueNumElements,

    const char* defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_SetString
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path,

    const char* value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t le_cfg_GetInt
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path,

    int32_t defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_SetInt
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path,

    int32_t value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
double le_cfg_GetFloat
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path,

    double defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_SetFloat
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path,

    double value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_cfg_GetBool
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path,

    bool defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_SetBool
(
    le_cfg_IteratorRef_t iteratorRef,

    const char* path,

    bool value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_QuickDeleteNode
(
    const char* path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_QuickSetEmpty
(
    const char* path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_QuickGetString
(
    const char* path,

    char* value,

    size_t valueNumElements,

    const char* defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_QuickSetString
(
    const char* path,

    const char* value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t le_cfg_QuickGetInt
(
    const char* path,

    int32_t defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_QuickSetInt
(
    const char* path,

    int32_t value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
double le_cfg_QuickGetFloat
(
    const char* path,

    double defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_QuickSetFloat
(
    const char* path,

    double value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_cfg_QuickGetBool
(
    const char* path,

    bool defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_QuickSetBool
(
    const char* path,

    bool value
);


#endif // LE_CFG_INTERFACE_H_INCLUDE_GUARD