Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
Go to the source code of this file.
Typedefs | |
typedef void(* | le_update_DisconnectHandler_t) (void *) |
Functions | |
void | le_update_ConnectService (void) |
le_result_t | le_update_TryConnectService (void) |
LE_FULL_API void | le_update_SetServerDisconnectHandler (le_update_DisconnectHandler_t disconnectHandler, void *contextPtr) |
LE_FULL_API void | le_update_SetNonExitServerDisconnectHandler (le_update_DisconnectHandler_t disconnectHandler, void *contextPtr) |
void | le_update_DisconnectService (void) |
le_update_ProgressHandlerRef_t | le_update_AddProgressHandler (le_update_ProgressHandlerFunc_t handlerPtr, void *contextPtr) |
void | le_update_RemoveProgressHandler (le_update_ProgressHandlerRef_t handlerRef) |
le_result_t | le_update_Start (int fd) |
le_result_t | le_update_Install (void) |
void | le_update_End (void) |
le_update_ErrorCode_t | le_update_GetErrorCode (void) |
int32_t | le_update_GetCurrentSysIndex (void) |
le_result_t | le_update_GetSystemHash (int32_t systemIndex, char *hashStr, size_t hashStrSize) |
int32_t | le_update_GetPreviousSystemIndex (int32_t systemIndex) |
Legato Update API include file.
Copyright (C) Sierra Wireless Inc.
typedef void(* le_update_DisconnectHandler_t) (void *) |
Type for handler called when a server disconnects.
void le_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 le_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.
LE_FULL_API void le_update_SetServerDisconnectHandler | ( | le_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.
LE_FULL_API void le_update_SetNonExitServerDisconnectHandler | ( | le_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 le_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.
le_update_ProgressHandlerRef_t le_update_AddProgressHandler | ( | le_update_ProgressHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'le_update_Progress'
Register for notification of the progress of a given update.
[in] | handlerPtr | Progress handler |
[in] | contextPtr |
void le_update_RemoveProgressHandler | ( | le_update_ProgressHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'le_update_Progress'
[in] | handlerRef |
le_result_t le_update_Start | ( | int | fd | ) |
Starts an update.
Progress is reported via the progress handler callback.
[in] | fd | Open file descriptor from which the update can be read. |
le_result_t le_update_Install | ( | void | ) |
Install the update
void le_update_End | ( | void | ) |
Ends an update session. If the update isn't finished yet, cancels it.
le_update_ErrorCode_t le_update_GetErrorCode | ( | void | ) |
Function to get error code when update fails.
int32_t le_update_GetCurrentSysIndex | ( | void | ) |
Get the index of the currently running system.
le_result_t le_update_GetSystemHash | ( | int32_t | systemIndex, |
char * | hashStr, | ||
size_t | hashStrSize | ||
) |
Gets the hash ID for a given system.
[in] | systemIndex | The system to read the hash for. |
[out] | hashStr | Buffer to hold the system hash string. |
[in] | hashStrSize |
int32_t le_update_GetPreviousSystemIndex | ( | int32_t | systemIndex | ) |
Get the index for the previous system in the chain, using the current system as a starting point.
[in] | systemIndex | Get the system that's older than this system. |