Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
#include "le_cfgAdmin_interface.h"
#include "le_cfgAdmin_messages.h"
#include "le_cfgAdmin_service.h"
Data Structures | |
struct | _ClientThreadData_t |
Macros | |
#define | LOCK_INIT le_mutex_Lock(le_ifgen_InitMutexRef); |
Locks the mutex. More... | |
#define | UNLOCK_INIT le_mutex_Unlock(le_ifgen_InitMutexRef); |
Unlocks the mutex. More... | |
Variables | |
static le_mem_PoolRef_t | _ClientThreadDataPool |
static pthread_key_t | _ThreadDataKey |
static bool | CommonDataInitialized = false |
le_mutex_Ref_t | le_ifgen_InitMutexRef |
#define LOCK_INIT le_mutex_Lock(le_ifgen_InitMutexRef); |
Locks the mutex.
#define UNLOCK_INIT le_mutex_Unlock(le_ifgen_InitMutexRef); |
Unlocks the mutex.
LE_MEM_DEFINE_STATIC_POOL | ( | le_cfgAdmin_ClientThreadData | , |
LE_CDATA_COMPONENT_COUNT | , | ||
sizeof(_ClientThreadData_t) | |||
) |
Static pool for client threads.
|
static |
Initialize thread specific data, and connect to the service for the current thread.
|
static |
Get a pointer to the client thread data for the current thread.
If the current thread does not have client data, then NULL is returned
__attribute__ | ( | (unused) | ) |
Return the sessionRef for the current thread.
If the current thread does not have a session ref, then this is a fatal error.
|
static |
Destructor function for client thread objects.
|
static |
Init data that is common across all threads.
|
static |
Connect to the service, using either blocking or non-blocking calls.
This function implements the details of the public ConnectService functions.
void le_cfgAdmin_ConnectService | ( | void | ) |
Connect the current client thread to the service providing this API. Block until the service is available.
For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.
This function is created automatically.
le_result_t le_cfgAdmin_TryConnectService | ( | void | ) |
Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.
For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.
This function is created automatically.
|
static |
void le_cfgAdmin_SetServerDisconnectHandler | ( | le_cfgAdmin_DisconnectHandler_t | disconnectHandler, |
void * | contextPtr | ||
) |
Set handler called when server disconnection is detected.
When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.
|
static |
void le_cfgAdmin_SetNonExitServerDisconnectHandler | ( | le_cfgAdmin_DisconnectHandler_t | disconnectHandler, |
void * | contextPtr | ||
) |
Set handler called when server disconnection is detected without exiting.
When a server connection is lost, call this handler without exit.
void le_cfgAdmin_DisconnectService | ( | void | ) |
Disconnect the current client thread from the service providing this API.
Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see apiFilesC_client.
This function is created automatically.
le_result_t le_cfgAdmin_ImportTree | ( | le_cfg_IteratorRef_t | iteratorRef, |
const char *LE_NONNULL | filePath, | ||
const char *LE_NONNULL | nodePath | ||
) |
Read a subset of the configuration tree from the given filePath. The tree then overwrites the node at the given nodePath.
This function will import a sub-tree as part of the iterator's current transaction. This allows you to create an iterator on a given node. Import a sub-tree, and then examine the contents of the import before deciding to commit the new data.
- LE_OK - The commit was completed successfuly. - LE_FAULT - An I/O error occured while reading the data. - LE_FORMAT_ERROR - The configuration data being imported appears corrupted.
[in] | iteratorRef | Write iterator that is being used for the import. |
[in] | filePath | Import the tree data from the this file. |
[in] | nodePath | Where in the tree should this import happen? Leave as an empty string to use the iterator's current node. |
le_result_t le_cfgAdmin_ExportTree | ( | le_cfg_IteratorRef_t | iteratorRef, |
const char *LE_NONNULL | filePath, | ||
const char *LE_NONNULL | nodePath | ||
) |
Take a node given from nodePath and stream it and it's children to the file given by filePath.
This funciton uses the iterator's read transaction, and takes a snapshot of the current state of the tree. The data write happens immediately.
- LE_OK - The commit was completed successfuly. - LE_FAULT - An I/O error occured while writing the data.
[in] | iteratorRef | Write iterator that is being used for the export. |
[in] | filePath | Import the tree data from the this file. |
[in] | nodePath | Where in the tree should this export happen? Leave as an empty string to use the iterator's current node. |
void le_cfgAdmin_DeleteTree | ( | const char *LE_NONNULL | treeName | ) |
Delete a tree from the system, both from the filesystem and from memory.
[in] | treeName | Name of the tree to delete. |
le_cfgAdmin_IteratorRef_t le_cfgAdmin_CreateTreeIterator | ( | void | ) |
Create a new iterator object for iterating over the list of trees currently managed by the config tree daemon.
void le_cfgAdmin_ReleaseTreeIterator | ( | le_cfgAdmin_IteratorRef_t | iteratorRef | ) |
Release the iterator and free it's memory back to the system.
[in] | iteratorRef | Iterator object to release. |
le_result_t le_cfgAdmin_GetTreeName | ( | le_cfgAdmin_IteratorRef_t | iteratorRef, |
char * | name, | ||
size_t | nameSize | ||
) |
Read the name of the tree currently pointed at by the iterator.
[in] | iteratorRef | Iterator object to read. |
[out] | name | Name of the currently referenced tree is passed in this out parameter. |
[in] | nameSize |
le_result_t le_cfgAdmin_NextTree | ( | le_cfgAdmin_IteratorRef_t | iteratorRef | ) |
Move onto the next tree in the list. If there are no more trees this function returns false, otherwise true is returned.
[in] | iteratorRef | Iterator to iterate. |
|
static |
The memory pool for client thread objects
|
static |
Key under which the pointer to the Thread Object (_ClientThreadData_t) will be kept in thread-local storage. This allows a thread to quickly get a pointer to its own Thread Object.
|
static |
This global flag is shared by all client threads, and is used to indicate whether the common data has been initialized.
le_mutex_Ref_t le_ifgen_InitMutexRef |
Mutex and associated macros for use with the above CommonDataInitialized.