Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
#include "taf_diagDIDBackend_interface.h"
#include "taf_diagDIDBackend_messages.h"
#include "taf_diagDIDBackend_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_diagDIDBackend_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_diagDIDBackend_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_diagDIDBackend_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_diagDIDBackend_SetServerDisconnectHandler | ( | taf_diagDIDBackend_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_diagDIDBackend_SetNonExitServerDisconnectHandler | ( | taf_diagDIDBackend_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_diagDIDBackend_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_diagDIDBackend_ReadDIDHandlerRef_t taf_diagDIDBackend_AddReadDIDHandler | ( | taf_diagDIDBackend_ReadDIDHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_diagDIDBackend_ReadDID'
This event provides information about the received ReadDID message.
[in] | handlerPtr | ReadDID message handler. |
[in] | contextPtr |
void taf_diagDIDBackend_RemoveReadDIDHandler | ( | taf_diagDIDBackend_ReadDIDHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_diagDIDBackend_ReadDID'
[in] | handlerRef |
le_result_t taf_diagDIDBackend_SendReadDIDResp | ( | taf_diagDIDBackend_ReadDIDRef_t | readDIDRef, |
taf_diagDIDBackend_ReadDIDErrorCode_t | errCode, | ||
const uint8_t * | dataPtr, | ||
size_t | dataSize | ||
) |
Sends a response message for the received ReadDID message.
[in] | readDIDRef | ReadDID message reference. |
[in] | errCode | Error code type. |
[in] | dataPtr | Data payload. |
[in] | dataSize |
taf_diagDIDBackend_WriteDIDHandlerRef_t taf_diagDIDBackend_AddWriteDIDHandler | ( | taf_diagDIDBackend_WriteDIDHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_diagDIDBackend_WriteDID'
This event provides information about the received ReadDID message.
[in] | handlerPtr | Received message handler. |
[in] | contextPtr |
void taf_diagDIDBackend_RemoveWriteDIDHandler | ( | taf_diagDIDBackend_WriteDIDHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_diagDIDBackend_WriteDID'
[in] | handlerRef |
le_result_t taf_diagDIDBackend_SendWriteDIDResp | ( | taf_diagDIDBackend_WriteDIDRef_t | rxMsgRef, |
taf_diagDIDBackend_WriteDIDErrorCode_t | errCode, | ||
uint16_t | dataId | ||
) |
Sends a response message for the WriteDID message.
[in] | rxMsgRef | Received message reference. |
[in] | errCode | Error code type. |
[in] | dataId | Data identifier. |
|
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.