le_cfg_interface.h
Go to the documentation of this file.
23 * Apps can also be granted read or write access to any other tree with any other name (e.g., a tree281 //--------------------------------------------------------------------------------------------------284 * Connect the current client thread to the service providing this API. Block until the service is287 * For each thread that wants to use this API, either ConnectService or TryConnectService must be288 * called before any other functions in this API. Normally, ConnectService is automatically called293 //--------------------------------------------------------------------------------------------------299 //--------------------------------------------------------------------------------------------------302 * Try to connect the current client thread to the service providing this API. Return with an error305 * For each thread that wants to use this API, either ConnectService or TryConnectService must be306 * called before any other functions in this API. Normally, ConnectService is automatically called313 * - LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.314 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).317 //--------------------------------------------------------------------------------------------------323 //--------------------------------------------------------------------------------------------------329 * longer a connection to the service, and the functions in this API can't be used. For details, see334 //--------------------------------------------------------------------------------------------------341 //--------------------------------------------------------------------------------------------------345 //--------------------------------------------------------------------------------------------------349 //--------------------------------------------------------------------------------------------------353 //--------------------------------------------------------------------------------------------------380 //--------------------------------------------------------------------------------------------------384 //--------------------------------------------------------------------------------------------------388 //--------------------------------------------------------------------------------------------------392 //--------------------------------------------------------------------------------------------------396 //--------------------------------------------------------------------------------------------------400 //--------------------------------------------------------------------------------------------------404 //--------------------------------------------------------------------------------------------------408 //--------------------------------------------------------------------------------------------------412 //--------------------------------------------------------------------------------------------------416 //--------------------------------------------------------------------------------------------------420 //--------------------------------------------------------------------------------------------------426 //--------------------------------------------------------------------------------------------------428 (432 //--------------------------------------------------------------------------------------------------440 * @note A tree transaction is global to that tree; a long-held read transaction will block other445 //--------------------------------------------------------------------------------------------------452 //--------------------------------------------------------------------------------------------------467 //--------------------------------------------------------------------------------------------------474 //--------------------------------------------------------------------------------------------------481 //--------------------------------------------------------------------------------------------------488 //--------------------------------------------------------------------------------------------------490 * Close and free the given iterator object. If the iterator is a write iterator, the transaction495 //--------------------------------------------------------------------------------------------------502 //--------------------------------------------------------------------------------------------------511 //--------------------------------------------------------------------------------------------------521 //--------------------------------------------------------------------------------------------------530 //--------------------------------------------------------------------------------------------------537 //--------------------------------------------------------------------------------------------------543 * children of this node are not written to, then this node will not persist even if the iterator is551 //--------------------------------------------------------------------------------------------------558 //--------------------------------------------------------------------------------------------------579 //--------------------------------------------------------------------------------------------------586 //--------------------------------------------------------------------------------------------------616 //--------------------------------------------------------------------------------------------------633 //--------------------------------------------------------------------------------------------------639 //--------------------------------------------------------------------------------------------------650 //--------------------------------------------------------------------------------------------------657 //--------------------------------------------------------------------------------------------------674 //--------------------------------------------------------------------------------------------------681 //--------------------------------------------------------------------------------------------------694 //--------------------------------------------------------------------------------------------------698 //--------------------------------------------------------------------------------------------------705 //--------------------------------------------------------------------------------------------------714 //--------------------------------------------------------------------------------------------------725 //--------------------------------------------------------------------------------------------------736 //--------------------------------------------------------------------------------------------------747 //--------------------------------------------------------------------------------------------------756 //--------------------------------------------------------------------------------------------------767 //--------------------------------------------------------------------------------------------------773 //--------------------------------------------------------------------------------------------------784 //--------------------------------------------------------------------------------------------------796 //--------------------------------------------------------------------------------------------------818 //--------------------------------------------------------------------------------------------------825 //--------------------------------------------------------------------------------------------------839 //--------------------------------------------------------------------------------------------------852 //--------------------------------------------------------------------------------------------------867 //--------------------------------------------------------------------------------------------------874 //--------------------------------------------------------------------------------------------------888 //--------------------------------------------------------------------------------------------------899 //--------------------------------------------------------------------------------------------------914 //--------------------------------------------------------------------------------------------------923 //--------------------------------------------------------------------------------------------------937 //--------------------------------------------------------------------------------------------------947 //--------------------------------------------------------------------------------------------------962 //--------------------------------------------------------------------------------------------------969 //--------------------------------------------------------------------------------------------------983 //--------------------------------------------------------------------------------------------------988 //--------------------------------------------------------------------------------------------------995 //--------------------------------------------------------------------------------------------------997 * Make a given node empty. If the node doesn't currently exist then it is created as a new empty1000 //--------------------------------------------------------------------------------------------------1007 //--------------------------------------------------------------------------------------------------1015 //--------------------------------------------------------------------------------------------------1031 //--------------------------------------------------------------------------------------------------1035 //--------------------------------------------------------------------------------------------------1045 //--------------------------------------------------------------------------------------------------1048 * value, then it will be rounded and returned as an integer. Otherwise If the underlying value is1053 //--------------------------------------------------------------------------------------------------1063 //--------------------------------------------------------------------------------------------------1067 //--------------------------------------------------------------------------------------------------1077 //--------------------------------------------------------------------------------------------------1087 //--------------------------------------------------------------------------------------------------1097 //--------------------------------------------------------------------------------------------------1103 //--------------------------------------------------------------------------------------------------1113 //--------------------------------------------------------------------------------------------------1120 //--------------------------------------------------------------------------------------------------1130 //--------------------------------------------------------------------------------------------------1134 //--------------------------------------------------------------------------------------------------void le_cfg_QuickSetInt(const char *path, int32_t value)void le_cfg_QuickSetFloat(const char *path, double value)void le_cfg_RemoveChangeHandler(le_cfg_ChangeHandlerRef_t addHandlerRef)void le_cfg_DisconnectService(void)void le_cfg_SetBool(le_cfg_IteratorRef_t iteratorRef, const char *path, bool value)void le_cfg_SetString(le_cfg_IteratorRef_t iteratorRef, const char *path, const char *value)bool le_cfg_QuickGetBool(const char *path, bool defaultValue)le_cfg_ChangeHandlerRef_t le_cfg_AddChangeHandler(const char *newPath, le_cfg_ChangeHandlerFunc_t handlerPtr, void *contextPtr)struct le_cfg_ChangeHandler * le_cfg_ChangeHandlerRef_tDefinition: le_cfg_interface.h:417le_result_t le_cfg_GoToNextSibling(le_cfg_IteratorRef_t iteratorRef)void le_cfg_SetFloat(le_cfg_IteratorRef_t iteratorRef, const char *path, double value)le_cfg_IteratorRef_t le_cfg_CreateReadTxn(const char *basePath)int32_t le_cfg_GetInt(le_cfg_IteratorRef_t iteratorRef, const char *path, int32_t defaultValue)double le_cfg_QuickGetFloat(const char *path, double defaultValue)void le_cfg_ConnectService(void)void le_cfg_GoToNode(le_cfg_IteratorRef_t iteratorRef, const char *newPath)void le_cfg_QuickDeleteNode(const char *path)void le_cfg_QuickSetString(const char *path, const char *value)void le_cfg_CommitTxn(le_cfg_IteratorRef_t iteratorRef)le_result_t le_cfg_GetPath(le_cfg_IteratorRef_t iteratorRef, const char *path, char *pathBuffer, size_t pathBufferNumElements)double le_cfg_GetFloat(le_cfg_IteratorRef_t iteratorRef, const char *path, double defaultValue)void le_cfg_DeleteNode(le_cfg_IteratorRef_t iteratorRef, const char *path)void le_cfg_QuickSetEmpty(const char *path)le_result_t le_cfg_TryConnectService(void)le_cfg_nodeType_t le_cfg_GetNodeType(le_cfg_IteratorRef_t iteratorRef, const char *path)void(* le_cfg_ChangeHandlerFunc_t)(void *contextPtr)Definition: le_cfg_interface.h:428bool le_cfg_NodeExists(le_cfg_IteratorRef_t iteratorRef, const char *path)le_cfg_IteratorRef_t le_cfg_CreateWriteTxn(const char *basePath)void le_cfg_SetInt(le_cfg_IteratorRef_t iteratorRef, const char *path, int32_t value)void le_cfg_CancelTxn(le_cfg_IteratorRef_t iteratorRef)bool le_cfg_IsEmpty(le_cfg_IteratorRef_t iteratorRef, const char *path)int32_t le_cfg_QuickGetInt(const char *path, int32_t defaultValue)le_result_t le_cfg_QuickGetString(const char *path, char *value, size_t valueNumElements, const char *defaultValue)le_result_t le_cfg_GetString(le_cfg_IteratorRef_t iteratorRef, const char *path, char *value, size_t valueNumElements, const char *defaultValue)le_result_t le_cfg_GoToFirstChild(le_cfg_IteratorRef_t iteratorRef)void le_cfg_SetEmpty(le_cfg_IteratorRef_t iteratorRef, const char *path)void le_cfg_QuickSetBool(const char *path, bool value)bool le_cfg_GetBool(le_cfg_IteratorRef_t iteratorRef, const char *path, bool defaultValue)le_result_t le_cfg_GetNodeName(le_cfg_IteratorRef_t iteratorRef, const char *path, char *name, size_t nameNumElements)le_result_t le_cfg_GoToParent(le_cfg_IteratorRef_t iteratorRef)Non-leaf node, this node is the parent of other nodes.Definition: le_cfg_interface.h:371