Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
#include "taf_diagSecurity_interface.h"
#include "taf_diagSecurity_messages.h"
#include "taf_diagSecurity_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_diagSecurity_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_diagSecurity_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_diagSecurity_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_diagSecurity_SetServerDisconnectHandler | ( | taf_diagSecurity_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_diagSecurity_SetNonExitServerDisconnectHandler | ( | taf_diagSecurity_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_diagSecurity_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_diagSecurity_ServiceRef_t taf_diagSecurity_GetService | ( | void | ) |
Gets the reference of a security service. If there is no security service, a new one will be created.
taf_diagSecurity_RxSesTypeCheckHandlerRef_t taf_diagSecurity_AddRxSesTypeCheckHandler | ( | taf_diagSecurity_ServiceRef_t | svcRef, |
taf_diagSecurity_RxSesTypeHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_diagSecurity_RxSesTypeCheck'
This event provides information on Rx session control type.
[in] | svcRef | Service reference. |
[in] | handlerPtr | Received message handler. |
[in] | contextPtr |
void taf_diagSecurity_RemoveRxSesTypeCheckHandler | ( | taf_diagSecurity_RxSesTypeCheckHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_diagSecurity_RxSesTypeCheck'
[in] | handlerRef |
le_result_t taf_diagSecurity_SendSesTypeCheckResp | ( | taf_diagSecurity_RxSesTypeCheckRef_t | rxSesTypeRef, |
taf_diagSecurity_SesControlErrorCode_t | errCode | ||
) |
Sends a response message for the condition check of Rx session control type.
[in] | rxSesTypeRef | Received session type reference. |
[in] | errCode | Error code type. |
taf_diagSecurity_SesChangeHandlerRef_t taf_diagSecurity_AddSesChangeHandler | ( | taf_diagSecurity_ServiceRef_t | svcRef, |
taf_diagSecurity_SesChangeHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_diagSecurity_SesChange'
This event provides information on session control type change.
[in] | svcRef | Service reference. |
[in] | handlerPtr | Received message handler. |
[in] | contextPtr |
void taf_diagSecurity_RemoveSesChangeHandler | ( | taf_diagSecurity_SesChangeHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_diagSecurity_SesChange'
[in] | handlerRef |
le_result_t taf_diagSecurity_GetCurrentSesType | ( | taf_diagSecurity_ServiceRef_t | svcRef, |
taf_diagSecurity_SessionType_t * | currentTypePtr | ||
) |
Gets the current session control type.
[in] | svcRef | Service reference. |
[out] | currentTypePtr | Current session control type. |
taf_diagSecurity_RxSecAccessMsgHandlerRef_t taf_diagSecurity_AddRxSecAccessMsgHandler | ( | taf_diagSecurity_ServiceRef_t | svcRef, |
taf_diagSecurity_RxSecAccessMsgHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_diagSecurity_RxSecAccessMsg'
This event provides information about the Rx security access message.
[in] | svcRef | Service reference. |
[in] | handlerPtr | Received message handler. |
[in] | contextPtr |
void taf_diagSecurity_RemoveRxSecAccessMsgHandler | ( | taf_diagSecurity_RxSecAccessMsgHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_diagSecurity_RxSecAccessMsg'
[in] | handlerRef |
le_result_t taf_diagSecurity_GetSecAccessPayloadLen | ( | taf_diagSecurity_RxSecAccessMsgRef_t | rxMsgRef, |
uint16_t * | payloadLenPtr | ||
) |
Gets the payload length of the Rx security access message.
[in] | rxMsgRef | Received message reference. |
[out] | payloadLenPtr | Security access payload length. |
le_result_t taf_diagSecurity_GetSecAccessPayload | ( | taf_diagSecurity_RxSecAccessMsgRef_t | rxMsgRef, |
uint8_t * | payloadPtr, | ||
size_t * | payloadSizePtr | ||
) |
Gets the payload of the Rx security access message. The payload can be either securityAccessDataRecord or securityKey based on request accessType.
[in] | rxMsgRef | Received message reference. |
[out] | payloadPtr | Security access payload. |
[in,out] | payloadSizePtr |
le_result_t taf_diagSecurity_SendSecAccessResp | ( | taf_diagSecurity_RxSecAccessMsgRef_t | rxMsgRef, |
taf_diagSecurity_SecAccessErrorCode_t | errCode, | ||
const uint8_t * | dataPtr, | ||
size_t | dataSize | ||
) |
Sends a response message for the Rx security access message.
[in] | rxMsgRef | Received message reference. |
[in] | errCode | Error code type. |
[in] | dataPtr | Payload data. |
[in] | dataSize |
le_result_t taf_diagSecurity_RemoveSvc | ( | taf_diagSecurity_ServiceRef_t | svcRef | ) |
Removes the security service.
[in] | svcRef | Service 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.