Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
#include "taf_diagUpdate_interface.h"
#include "taf_diagUpdate_messages.h"
#include "taf_diagUpdate_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_diagUpdate_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_diagUpdate_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_diagUpdate_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_diagUpdate_SetServerDisconnectHandler | ( | taf_diagUpdate_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_diagUpdate_SetNonExitServerDisconnectHandler | ( | taf_diagUpdate_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_diagUpdate_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_diagUpdate_ServiceRef_t taf_diagUpdate_GetService | ( | void | ) |
Gets the reference to a Diag update service, if there's no Diag update service, a new one will be created.
taf_diagUpdate_RxFileXferMsgHandlerRef_t taf_diagUpdate_AddRxFileXferMsgHandler | ( | taf_diagUpdate_ServiceRef_t | svcRef, |
taf_diagUpdate_RxFileXferMsgHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_diagUpdate_RxFileXferMsg'
This event provides information on RequestFileTransfer message.
[in] | svcRef | Service reference. |
[in] | handlerPtr | Received message handler. |
[in] | contextPtr |
void taf_diagUpdate_RemoveRxFileXferMsgHandler | ( | taf_diagUpdate_RxFileXferMsgHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_diagUpdate_RxFileXferMsg'
[in] | handlerRef |
le_result_t taf_diagUpdate_GetFilePathAndName | ( | taf_diagUpdate_RxFileXferMsgRef_t | rxMsgRef, |
uint8_t * | fileNamePtr, | ||
size_t * | fileNameSizePtr | ||
) |
Gets the file path and name of the Rx RequestFileTransfer message.
[in] | rxMsgRef | Receive message reference. |
[out] | fileNamePtr | File path and name. |
[in,out] | fileNameSizePtr |
le_result_t taf_diagUpdate_GetDataFormatID | ( | taf_diagUpdate_RxFileXferMsgRef_t | rxMsgRef, |
uint8_t * | dataFormatIDPtr | ||
) |
Gets the data format ID of the Rx RequestFileTransfer message.
[in] | rxMsgRef | Receive message reference. |
[out] | dataFormatIDPtr | Data format ID. |
le_result_t taf_diagUpdate_GetUnCompFileSize | ( | taf_diagUpdate_RxFileXferMsgRef_t | rxMsgRef, |
uint32_t * | unCompFileSizePtr | ||
) |
Gets the size of the uncompressed file of the Rx RequestFileTransfer message.
[in] | rxMsgRef | Received message reference. |
[out] | unCompFileSizePtr | Size of the uncompressed file. |
le_result_t taf_diagUpdate_GetCompFileSize | ( | taf_diagUpdate_RxFileXferMsgRef_t | rxMsgRef, |
uint32_t * | compFileSizePtr | ||
) |
Gets the size of the compressed file of the Rx RequestFileTransfer message.
[in] | rxMsgRef | Received message reference. |
[out] | compFileSizePtr | Size of the compressed file. |
le_result_t taf_diagUpdate_SetFilePosition | ( | taf_diagUpdate_RxFileXferMsgRef_t | rxMsgRef, |
uint64_t | filePosition | ||
) |
Sets the file position into RequestFileTransfer response message.
[in] | rxMsgRef | Received message reference. |
[in] | filePosition | Specifies the byte position for downloading file resume. |
le_result_t taf_diagUpdate_SetFileSizeOrDirInfoLength | ( | taf_diagUpdate_RxFileXferMsgRef_t | rxMsgRef, |
uint64_t | fileSizeUncompressedOrDirInfoLength, | ||
uint64_t | fileSizeCompressed | ||
) |
Sets the fileSizeUncompressedOrDirInfoLength and fileSizeCompressed into RequestFileTransfer response message.
[in] | rxMsgRef | Received message reference. |
[in] | fileSizeUncompressedOrDirInfoLength | Specifies the size of the uncompressed file to be uploaded or the length of the directory information to be read in bytes. |
[in] | fileSizeCompressed | Specifies the size of the compressed file in bytes. |
le_result_t taf_diagUpdate_SendFileXferResp | ( | taf_diagUpdate_RxFileXferMsgRef_t | rxMsgRef, |
taf_diagUpdate_FileXferErrorCode_t | errCode | ||
) |
Sends a response message for the Rx RequestFileTransfer message.
[in] | rxMsgRef | Received message reference. |
[in] | errCode | Error code type. |
taf_diagUpdate_RxXferDataMsgHandlerRef_t taf_diagUpdate_AddRxXferDataMsgHandler | ( | taf_diagUpdate_ServiceRef_t | svcRef, |
taf_diagUpdate_RxXferDataMsgHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_diagUpdate_RxXferDataMsg'
This event provides information on TransferData message.
[in] | svcRef | Service reference. |
[in] | handlerPtr | Received message handler. |
[in] | contextPtr |
void taf_diagUpdate_RemoveRxXferDataMsgHandler | ( | taf_diagUpdate_RxXferDataMsgHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_diagUpdate_RxXferDataMsg'
[in] | handlerRef |
le_result_t taf_diagUpdate_GetblockSeqCount | ( | taf_diagUpdate_RxXferDataMsgRef_t | rxMsgRef, |
uint8_t * | countPtr | ||
) |
Gets the block sequence counter of the Rx TransferData message.
[in] | rxMsgRef | Received message reference. |
[out] | countPtr | Block sequence counter. |
le_result_t taf_diagUpdate_GetXferDataParamRecLen | ( | taf_diagUpdate_RxXferDataMsgRef_t | rxMsgRef, |
uint16_t * | xferDataRecLenPtr | ||
) |
Gets the the data request record length of the Rx TransferData message.
[in] | rxMsgRef | Received message reference. |
[out] | xferDataRecLenPtr | Transfer data request parameter record length. |
le_result_t taf_diagUpdate_GetXferDataParamRec | ( | taf_diagUpdate_RxXferDataMsgRef_t | rxMsgRef, |
uint8_t * | xferDataRecPtr, | ||
size_t * | xferDataRecSizePtr | ||
) |
Gets the transfer data request record of the Rx TransferData message.
[in] | rxMsgRef | Received message reference. |
[out] | xferDataRecPtr | Transfer data request parameter record. |
[in,out] | xferDataRecSizePtr |
le_result_t taf_diagUpdate_SendXferDataResp | ( | taf_diagUpdate_RxXferDataMsgRef_t | rxMsgRef, |
taf_diagUpdate_XferDataErrorCode_t | errCode, | ||
const uint8_t * | dataPtr, | ||
size_t | dataSize | ||
) |
Sends a response message for the Rx TransferData message.
[in] | rxMsgRef | Received message reference. |
[in] | errCode | Error code type. |
[in] | dataPtr | Payload data. |
[in] | dataSize |
taf_diagUpdate_RxXferExitMsgHandlerRef_t taf_diagUpdate_AddRxXferExitMsgHandler | ( | taf_diagUpdate_ServiceRef_t | svcRef, |
taf_diagUpdate_RxXferExitMsgHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_diagUpdate_RxXferExitMsg'
This event provides information on RequestTransferExit message.
[in] | svcRef | Service reference. |
[in] | handlerPtr | Received message handler. |
[in] | contextPtr |
void taf_diagUpdate_RemoveRxXferExitMsgHandler | ( | taf_diagUpdate_RxXferExitMsgHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_diagUpdate_RxXferExitMsg'
[in] | handlerRef |
le_result_t taf_diagUpdate_GetXferExitParamRecLen | ( | taf_diagUpdate_RxXferExitMsgRef_t | rxMsgRef, |
uint16_t * | exitDataRecLenPtr | ||
) |
Gets the length of the received RequestTransferExit message.
[in] | rxMsgRef | Received message reference. |
[out] | exitDataRecLenPtr | Transfer exit request parameter record length. |
le_result_t taf_diagUpdate_GetXferExitParamRec | ( | taf_diagUpdate_RxXferExitMsgRef_t | rxMsgRef, |
uint8_t * | exitDataRecPtr, | ||
size_t * | exitDataRecSizePtr | ||
) |
Gets the transfer exit request parameter record of the Rx RequestTransferExit message.
[in] | rxMsgRef | Received message reference. |
[out] | exitDataRecPtr | Transfer exit request parameter record. |
[in,out] | exitDataRecSizePtr |
le_result_t taf_diagUpdate_SendXferExitResp | ( | taf_diagUpdate_RxXferExitMsgRef_t | rxMsgRef, |
taf_diagUpdate_XferExitErrorCode_t | errCode, | ||
const uint8_t * | dataPtr, | ||
size_t | dataSize | ||
) |
Sends a response message for the Rx RequestTransferExit message.
[in] | rxMsgRef | Received message reference. |
[in] | errCode | Error code type. |
[in] | dataPtr | Payload data. |
[in] | dataSize |
le_result_t taf_diagUpdate_RemoveSvc | ( | taf_diagUpdate_ServiceRef_t | svcRef | ) |
Removes the Update server 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.