Go to the source code of this file.
Typedefs | |
typedef struct le_avc_StatusEventHandler * | le_avc_StatusEventHandlerRef_t |
typedef struct le_avc_BlockRequest * | le_avc_BlockRequestRef_t |
typedef void(* | le_avc_StatusHandlerFunc_t) (le_avc_Status_t updateStatus, int32_t totalNumBytes, int32_t dloadProgress, void *contextPtr) |
Enumerations | |
enum | le_avc_Status_t { LE_AVC_NO_UPDATE, LE_AVC_DOWNLOAD_PENDING, LE_AVC_DOWNLOAD_IN_PROGRESS, LE_AVC_DOWNLOAD_COMPLETE, LE_AVC_DOWNLOAD_FAILED, LE_AVC_INSTALL_PENDING, LE_AVC_INSTALL_IN_PROGRESS, LE_AVC_INSTALL_COMPLETE, LE_AVC_INSTALL_FAILED, LE_AVC_UNINSTALL_PENDING, LE_AVC_UNINSTALL_IN_PROGRESS, LE_AVC_UNINSTALL_COMPLETE, LE_AVC_UNINSTALL_FAILED, LE_AVC_SESSION_STARTED, LE_AVC_SESSION_STOPPED } |
enum | le_avc_UpdateType_t { LE_AVC_UNKNOWN_UPDATE, LE_AVC_FIRMWARE_UPDATE, LE_AVC_FRAMEWORK_UPDATE, LE_AVC_APPLICATION_UPDATE } |
Functions | |
void | le_avc_ConnectService (void) |
void | le_avc_DisconnectService (void) |
le_avc_StatusEventHandlerRef_t | le_avc_AddStatusEventHandler (le_avc_StatusHandlerFunc_t handlerPtr, void *contextPtr) |
void | le_avc_RemoveStatusEventHandler (le_avc_StatusEventHandlerRef_t addHandlerRef) |
le_result_t | le_avc_StartSession (void) |
le_result_t | le_avc_StopSession (void) |
le_result_t | le_avc_AcceptDownload (void) |
le_result_t | le_avc_DeferDownload (uint32_t deferMinutes) |
le_result_t | le_avc_AcceptInstall (void) |
le_result_t | le_avc_DeferInstall (uint32_t deferMinutes) |
le_result_t | le_avc_AcceptUninstall (void) |
le_result_t | le_avc_DeferUninstall (uint32_t deferMinutes) |
le_result_t | le_avc_GetUpdateType (le_avc_UpdateType_t *updateTypePtr) |
le_result_t | le_avc_GetAppUpdateName (char *updateName, size_t updateNameNumElements) |
le_avc_BlockRequestRef_t | le_avc_BlockInstall (void) |
void | le_avc_UnblockInstall (le_avc_BlockRequestRef_t blockRef) |
Legato AirVantage Connector include file.
Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
typedef struct le_avc_BlockRequest* le_avc_BlockRequestRef_t |
Reference returned by BlockInstall function and used by UnblockInstall function
typedef struct le_avc_StatusEventHandler* le_avc_StatusEventHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'le_avc_StatusEvent'
typedef void(* le_avc_StatusHandlerFunc_t) (le_avc_Status_t updateStatus, int32_t totalNumBytes, int32_t dloadProgress, void *contextPtr) |
Handler for update availability status
updateStatus | status of pending update, if available |
totalNumBytes | Total number of bytes to be downloaded only valid when updateStatus is one of DOWNLOAD_PENDING, DOWNLOAD_IN_PROGRESS or DOWNLOAD_COMPLETE. returns -1 if value is unknown |
dloadProgress | download completion in percentage only valid when updateStatus is one of DOWNLOAD_PENDING, DOWNLOAD_IN_PROGRESS or DOWNLOAD_COMPLETE. returns -1 if value is unknown |
contextPtr |
enum le_avc_Status_t |
Status of session or update
If an update is pending, it must first be downloaded and then installed.
enum le_avc_UpdateType_t |
The type of pending update
le_result_t le_avc_AcceptDownload | ( | void | ) |
Accept the currently pending download
le_result_t le_avc_AcceptInstall | ( | void | ) |
Accept the currently pending install
le_result_t le_avc_AcceptUninstall | ( | void | ) |
Accept the currently pending uninstall
le_avc_StatusEventHandlerRef_t le_avc_AddStatusEventHandler | ( | le_avc_StatusHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'le_avc_StatusEvent'
This event provides information on update availability status
[in] | handlerPtr | |
[in] | contextPtr |
le_avc_BlockRequestRef_t le_avc_BlockInstall | ( | void | ) |
Prevent any pending updates from being installed.
void le_avc_ConnectService | ( | void | ) |
Connect the client to the service
le_result_t le_avc_DeferDownload | ( | uint32_t | deferMinutes | ) |
Defer the currently pending download, for the given number of minutes
[in] | deferMinutes |
le_result_t le_avc_DeferInstall | ( | uint32_t | deferMinutes | ) |
Defer the currently pending install
[in] | deferMinutes |
le_result_t le_avc_DeferUninstall | ( | uint32_t | deferMinutes | ) |
Defer the currently pending uninstall
[in] | deferMinutes |
void le_avc_DisconnectService | ( | void | ) |
Disconnect the client from the service
le_result_t le_avc_GetAppUpdateName | ( | char * | updateName, |
size_t | updateNameNumElements | ||
) |
Get the name for the currently pending app update
[out] | updateName | |
[in] | updateNameNumElements |
le_result_t le_avc_GetUpdateType | ( | le_avc_UpdateType_t * | updateTypePtr | ) |
Get the update type of the currently pending update
[out] | updateTypePtr |
void le_avc_RemoveStatusEventHandler | ( | le_avc_StatusEventHandlerRef_t | addHandlerRef | ) |
Remove handler function for EVENT 'le_avc_StatusEvent'
[in] | addHandlerRef |
le_result_t le_avc_StartSession | ( | void | ) |
Start a session with the AirVantage server
This will cause a query to be sent to the server, for pending updates. If a download was previously suspended, then this resumes the download.
le_result_t le_avc_StopSession | ( | void | ) |
Stop a session with the AirVantage server
If a download is in progress, then this suspends the download.
void le_avc_UnblockInstall | ( | le_avc_BlockRequestRef_t | blockRef | ) |
Allow any pending updates to be installed
[in] | blockRef | block request ref returned by le_avc_BlockInstall |