le_cfg_common.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_COMMON_H_INCLUDE_GUARD
#define LE_CFG_COMMON_H_INCLUDE_GUARD


#include "legato.h"

#define IFGEN_LE_CFG_PROTOCOL_ID "4db45ee4887ce0305738f97e9c15d721"
#define IFGEN_LE_CFG_MSG_SIZE 9239



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

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_CFG_BINARY_LEN 8704

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_CFG_NAME_LEN 255

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_CFG_NAME_LEN_BYTES 256

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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_CFG_TYPE_EMPTY = 0,
    LE_CFG_TYPE_STRING = 1,
    LE_CFG_TYPE_BOOL = 2,
    LE_CFG_TYPE_INT = 3,
    LE_CFG_TYPE_FLOAT = 4,
    LE_CFG_TYPE_STEM = 5,
    LE_CFG_TYPE_DOESNT_EXIST = 6
}
le_cfg_nodeType_t;


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


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_le_cfg_HasLocalBinding
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_InitCommonData
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_CleanupCommonData
(
    le_msg_SessionRef_t _ifgen_sessionRef
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_le_cfg_OpenSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
    bool isBlocking
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_cfg_IteratorRef_t ifgen_le_cfg_CreateReadTxn
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL basePath
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_cfg_IteratorRef_t ifgen_le_cfg_CreateWriteTxn
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL basePath
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_CommitTxn
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_CancelTxn
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_GoToNode
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL newPath
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_le_cfg_GoToParent
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_le_cfg_GoToFirstChild
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_le_cfg_GoToNextSibling
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_le_cfg_GetPath
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path,
        char* pathBuffer,
        size_t pathBufferSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_cfg_nodeType_t ifgen_le_cfg_GetNodeType
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_le_cfg_GetNodeName
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path,
        char* name,
        size_t nameSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_cfg_ChangeHandlerRef_t ifgen_le_cfg_AddChangeHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL newPath,
        le_cfg_ChangeHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_RemoveChangeHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_ChangeHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_DeleteNode
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_le_cfg_IsEmpty
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_SetEmpty
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_le_cfg_NodeExists
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_le_cfg_GetString
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path,
        char* value,
        size_t valueSize,
        const char* LE_NONNULL defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_SetString
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path,
        const char* LE_NONNULL value
);

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_SetBinary
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path,
        const uint8_t* valuePtr,
        size_t valueSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED int32_t ifgen_le_cfg_GetInt
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path,
        int32_t defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_SetInt
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path,
        int32_t value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED double ifgen_le_cfg_GetFloat
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path,
        double defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_SetFloat
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path,
        double value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_le_cfg_GetBool
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path,
        bool defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_SetBool
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_cfg_IteratorRef_t iteratorRef,
        const char* LE_NONNULL path,
        bool value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_QuickDeleteNode
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_QuickSetEmpty
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL path
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_le_cfg_QuickGetString
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL path,
        char* value,
        size_t valueSize,
        const char* LE_NONNULL defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_QuickSetString
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL path,
        const char* LE_NONNULL value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_le_cfg_QuickGetBinary
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL path,
        uint8_t* valuePtr,
        size_t* valueSizePtr,
        const uint8_t* defaultValuePtr,
        size_t defaultValueSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_QuickSetBinary
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL path,
        const uint8_t* valuePtr,
        size_t valueSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED int32_t ifgen_le_cfg_QuickGetInt
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL path,
        int32_t defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_QuickSetInt
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL path,
        int32_t value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED double ifgen_le_cfg_QuickGetFloat
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL path,
        double defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_QuickSetFloat
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL path,
        double value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_le_cfg_QuickGetBool
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL path,
        bool defaultValue
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_cfg_QuickSetBool
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL path,
        bool value
);

#endif // LE_CFG_COMMON_H_INCLUDE_GUARD