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"

// Internal includes for this interface
#include "le_cfg_common.h"
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_cfg_DisconnectHandler_t)(void *);

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_TryConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void le_cfg_SetServerDisconnectHandler
(
    le_cfg_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void le_cfg_SetNonExitServerDisconnectHandler
(
    le_cfg_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

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

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_cfg_IteratorRef_t le_cfg_CreateWriteTxn
(
    const char* LE_NONNULL 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* LE_NONNULL 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* LE_NONNULL path,
    char* pathBuffer,
    size_t pathBufferSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_cfg_nodeType_t le_cfg_GetNodeType
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_GetNodeName
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path,
    char* name,
    size_t nameSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_cfg_ChangeHandlerRef_t le_cfg_AddChangeHandler
(
    const char* LE_NONNULL newPath,
    le_cfg_ChangeHandlerFunc_t handlerPtr,
    void* contextPtr
);

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_DeleteNode
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_cfg_IsEmpty
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_SetEmpty
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_cfg_NodeExists
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_GetString
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path,
    char* value,
    size_t valueSize,
    const char* LE_NONNULL defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_SetString
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path,
    const char* LE_NONNULL value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_GetBinary
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path,
    uint8_t* valuePtr,
    size_t* valueSizePtr,
    const uint8_t* defaultValuePtr,
    size_t defaultValueSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_SetBinary
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path,
    const uint8_t* valuePtr,
    size_t valueSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t le_cfg_GetInt
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path,
    int32_t defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_SetInt
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path,
    int32_t value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
double le_cfg_GetFloat
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path,
    double defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_SetFloat
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path,
    double value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_cfg_GetBool
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path,
    bool defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_SetBool
(
    le_cfg_IteratorRef_t iteratorRef,
    const char* LE_NONNULL path,
    bool value
);

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

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_QuickGetString
(
    const char* LE_NONNULL path,
    char* value,
    size_t valueSize,
    const char* LE_NONNULL defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_QuickSetString
(
    const char* LE_NONNULL path,
    const char* LE_NONNULL value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_cfg_QuickGetBinary
(
    const char* LE_NONNULL path,
    uint8_t* valuePtr,
    size_t* valueSizePtr,
    const uint8_t* defaultValuePtr,
    size_t defaultValueSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_QuickSetBinary
(
    const char* LE_NONNULL path,
    const uint8_t* valuePtr,
    size_t valueSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t le_cfg_QuickGetInt
(
    const char* LE_NONNULL path,
    int32_t defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_QuickSetInt
(
    const char* LE_NONNULL path,
    int32_t value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
double le_cfg_QuickGetFloat
(
    const char* LE_NONNULL path,
    double defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_QuickSetFloat
(
    const char* LE_NONNULL path,
    double value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_cfg_QuickGetBool
(
    const char* LE_NONNULL path,
    bool defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_cfg_QuickSetBool
(
    const char* LE_NONNULL path,
    bool value
);

#endif // LE_CFG_INTERFACE_H_INCLUDE_GUARD