Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
#include "taf_mngdConn_interface.h"
#include "taf_mngdConn_messages.h"
#include "taf_mngdConn_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 | ( | taf_mngdConn_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 taf_mngdConn_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 taf_mngdConn_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 taf_mngdConn_SetServerDisconnectHandler | ( | taf_mngdConn_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 taf_mngdConn_SetNonExitServerDisconnectHandler | ( | taf_mngdConn_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 taf_mngdConn_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.
taf_mngdConn_DataStateHandlerRef_t taf_mngdConn_AddDataStateHandler | ( | taf_mngdConn_DataRef_t | dataRef, |
taf_mngdConn_DataStateHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_mngdConn_DataState'
Events to report data state.
[in] | dataRef | The data reference. |
[in] | handlerPtr | The event handler reference. |
[in] | contextPtr |
void taf_mngdConn_RemoveDataStateHandler | ( | taf_mngdConn_DataStateHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_mngdConn_DataState'
[in] | handlerRef |
taf_mngdConn_RecoveryStateHandlerRef_t taf_mngdConn_AddRecoveryStateHandler | ( | taf_mngdConn_RecoveryStateHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_mngdConn_RecoveryState'
Events to report recovery state.
[in] | handlerPtr | The event handler reference. |
[in] | contextPtr |
void taf_mngdConn_RemoveRecoveryStateHandler | ( | taf_mngdConn_RecoveryStateHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_mngdConn_RecoveryState'
[in] | handlerRef |
taf_mngdConn_DataRef_t taf_mngdConn_GetData | ( | uint8_t | dataId | ) |
Gets the data reference for the given data ID(as provided in the configuration JSON).
[in] | dataId | The data ID to use. |
taf_mngdConn_DataRef_t taf_mngdConn_GetDataByName | ( | const char *LE_NONNULL | dataName | ) |
Gets the data reference for the given data name(as provided in the configuration JSON).
[in] | dataName | The data name to use. |
le_result_t taf_mngdConn_GetDataIdByRef | ( | taf_mngdConn_DataRef_t | dataRef, |
uint8_t * | dataIdPtr | ||
) |
Gets the data object ID (as provided in the configuration JSON) for the given data reference.
[in] | dataRef | The data reference. |
[out] | dataIdPtr | The data object ID from the configuration JSON. |
le_result_t taf_mngdConn_GetDataNameByRef | ( | taf_mngdConn_DataRef_t | dataRef, |
char * | dataName, | ||
size_t | dataNameSize | ||
) |
Gets the data object name (as provided in the configuration JSON) for the given data reference.
[in] | dataRef | The data reference. |
[out] | dataName | The data object name from the configuration JSON. |
[in] | dataNameSize |
le_result_t taf_mngdConn_StartData | ( | taf_mngdConn_DataRef_t | dataRef | ) |
Starts a data session for the given data reference. This API should be used when the value of "AutoStart" is "No" in the configuration file.
The service tracks clients that call StartData for Data objects with AutoStart:No and is used to manage StopData behavior.
[in] | dataRef | The data reference. |
le_result_t taf_mngdConn_StopData | ( | taf_mngdConn_DataRef_t | dataRef | ) |
Stops a data cellular session for the given data reference.
Data will be stopped only when all clients that have called StartData for data objects with AutoStart:No either stop data or exit.
[in] | dataRef | The data reference. |
le_result_t taf_mngdConn_GetDataConnectionState | ( | taf_mngdConn_DataRef_t | dataRef, |
taf_mngdConn_DataState_t * | statePtr | ||
) |
Gets the data connection state information for the given data reference.
[in] | dataRef | The data reference. |
[out] | statePtr | The data state. |
le_result_t taf_mngdConn_GetDataConnectionIPAddresses | ( | taf_mngdConn_DataRef_t | dataRef, |
char * | IPv4Addr, | ||
size_t | IPv4AddrSize, | ||
char * | IPv6Addr, | ||
size_t | IPv6AddrSize | ||
) |
Gets the data connection IP addresses for the given data reference. An empty string is returned if either IP address is not available.
[in] | dataRef | The data reference. |
[out] | IPv4Addr | IPv4 Address. |
[in] | IPv4AddrSize | |
[out] | IPv6Addr | IPv6 Address. |
[in] | IPv6AddrSize |
le_result_t taf_mngdConn_StartDataRetry | ( | taf_mngdConn_DataRef_t | dataRef | ) |
Starts the data retry mechanism. If data session is connected, the data session will be disconnected before data retry mechanism is started. This function is asynchronous and applications should monitor taf_mngdConn_DataState_t events.
[in] | dataRef | The data reference. |
le_result_t taf_mngdConn_CancelL1Recovery | ( | taf_mngdConn_DataRef_t | dataRef | ) |
Cancels a scheduled L1 recovery process. A L1 recovery could be scheduled for one or more data connetions. For a scheduled L1 recovery process to be canceled, this API should be called for all data references for which L1 recovery has been scheduled.
[in] | dataRef | The data reference. |
le_result_t taf_mngdConn_CancelL2Recovery | ( | taf_mngdConn_DataRef_t | dataRef | ) |
Cancels a scheduled L2 recovery process. A L2 recovery could be scheduled for one or more data connetions. For a scheduled L2 recovery process to be canceled, this API should be called for all data references for which L2 recovery has been scheduled.
[in] | dataRef | The data reference. |
|
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.