Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
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_update_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_update_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_update_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_update_SetServerDisconnectHandler | ( | taf_update_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_update_SetNonExitServerDisconnectHandler | ( | taf_update_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_update_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_update_StateHandlerRef_t taf_update_AddStateHandler | ( | taf_update_StateHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_update_State'
Event to report update progress.
[in] | handlerPtr | Handler for update state. |
[in] | contextPtr |
void taf_update_RemoveStateHandler | ( | taf_update_StateHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_update_State'
[in] | handlerRef |
void taf_update_Download | ( | void | ) |
Downloads an OTA package from a cloud server.
le_result_t taf_update_Install | ( | taf_update_OTA_t | ota, |
const char *LE_NONNULL | name | ||
) |
Installs an OTA package on the target device.
[in] | ota | OTA workflow. |
[in] | name | OTA package name. |
le_result_t taf_update_GetDownloadSession | ( | const char *LE_NONNULL | cfgFile, |
taf_update_SessionRef_t * | sessionPtr | ||
) |
Gets download session.
[in] | cfgFile | Configuration file for download session. |
[out] | sessionPtr | Download session reference. |
le_result_t taf_update_StartDownload | ( | taf_update_SessionRef_t | session | ) |
Starts download.
[in] | session | Download session reference. |
le_result_t taf_update_PauseDownload | ( | taf_update_SessionRef_t | session | ) |
Pauses download.
[in] | session | Download session reference. |
le_result_t taf_update_ResumeDownload | ( | taf_update_SessionRef_t | session | ) |
Resumes download.
[in] | session | Download session reference. |
le_result_t taf_update_CancelDownload | ( | taf_update_SessionRef_t | session | ) |
Cancels download.
[in] | session | Download session reference. |
le_result_t taf_update_GetInstallationSession | ( | taf_update_PackageType_t | pkgType, |
const char *LE_NONNULL | cfgFile, | ||
taf_update_SessionRef_t * | sessionPtr | ||
) |
Gets installation session.
[in] | pkgType | Package type for installation. |
[in] | cfgFile | Configuration file for installation session. |
[out] | sessionPtr | Installation session reference. |
le_result_t taf_update_InstallPreCheck | ( | taf_update_SessionRef_t | session, |
const char *LE_NONNULL | manifest | ||
) |
Checks prerequisites for installation.
[in] | session | Installation session reference. |
[in] | manifest | Manifest for pre-check. |
le_result_t taf_update_StartInstall | ( | taf_update_SessionRef_t | session, |
const char *LE_NONNULL | pkgPath | ||
) |
Start installation.
[in] | session | Installation session reference. |
[in] | pkgPath | Package path. |
le_result_t taf_update_InstallPostCheck | ( | taf_update_SessionRef_t | session | ) |
Verification post installation, check if flashing properly on inactive bank.
[in] | session | Installation session reference. |
le_result_t taf_update_GetActiveBank | ( | taf_update_SessionRef_t | session, |
taf_update_Bank_t * | bankPtr | ||
) |
Gets the active bank.
[in] | session | Installation session reference. |
[out] | bankPtr | The active bank. |
le_result_t taf_update_VerifyActivation | ( | taf_update_SessionRef_t | session, |
const char *LE_NONNULL | manifest | ||
) |
Activation verification, check if each component has the updated version.
[in] | session | Installation session reference. |
[in] | manifest | Manifest for activation verification. |
le_result_t taf_update_Rollback | ( | taf_update_SessionRef_t | session | ) |
Rollback to previous configurations to keep pesistency.
[in] | session | Installation session reference. |
le_result_t taf_update_Sync | ( | taf_update_SessionRef_t | session | ) |
Bank synchronization.
[in] | session | Installation session 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.