le_avc_interface.h
Go to the documentation of this file.
65 * If an uninstall is pending, then le_avc_AcceptUninstall() can be used to allow the uninstall to103 * The control app can add a session controller handler using le_avc_AddSessionRequestEventHandler().104 * If the control app registers a session request event handler, requests by user apps to open or105 * close session will be forwarded to the control app. If the control app doesn't register a session111 * according to the polling timer. The device initates the connection periodically, so that it can112 * poll the server if there are any pending jobs. Writing 0 to the polling timer disables polling113 * mode. Polling timer values range from 0 to 525600 minutes. The polling timer value is persistent.114 * le_avc_GetPollingTimer() reads the polling timer and le_avc_SetPollingTimer() writes the polling120 * failed, http error code received), the embedded module will initiate a new connection according121 * to the values defined in the retry timers. The timers are tried in sequence until a connection is123 * exhausted, a connection will be initiated only on a command from user (le_avc_startSession() )127 * le_avc_SetRetryTimers() writes the polling timers. When writing to the retry timers, values of149 * After an AirVantage session is started, if there's no activity from the modem within the timer interval,150 * then LE_AVC_NO_UPDATE state will be returned to the app. However, this modem activity timeout can153 * then it will be used instead of the default value of 20 seconds. The following steps should be186 //--------------------------------------------------------------------------------------------------189 * Connect the current client thread to the service providing this API. Block until the service is192 * For each thread that wants to use this API, either ConnectService or TryConnectService must be193 * called before any other functions in this API. Normally, ConnectService is automatically called198 //--------------------------------------------------------------------------------------------------204 //--------------------------------------------------------------------------------------------------207 * Try to connect the current client thread to the service providing this API. Return with an error210 * For each thread that wants to use this API, either ConnectService or TryConnectService must be211 * called before any other functions in this API. Normally, ConnectService is automatically called218 * - LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.219 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).222 //--------------------------------------------------------------------------------------------------228 //--------------------------------------------------------------------------------------------------234 * longer a connection to the service, and the functions in this API can't be used. For details, see239 //--------------------------------------------------------------------------------------------------246 //--------------------------------------------------------------------------------------------------250 //--------------------------------------------------------------------------------------------------254 //--------------------------------------------------------------------------------------------------258 //--------------------------------------------------------------------------------------------------262 //--------------------------------------------------------------------------------------------------266 //--------------------------------------------------------------------------------------------------270 //--------------------------------------------------------------------------------------------------274 //--------------------------------------------------------------------------------------------------278 //--------------------------------------------------------------------------------------------------282 //--------------------------------------------------------------------------------------------------286 //--------------------------------------------------------------------------------------------------290 //--------------------------------------------------------------------------------------------------294 //--------------------------------------------------------------------------------------------------298 //--------------------------------------------------------------------------------------------------302 //--------------------------------------------------------------------------------------------------306 //--------------------------------------------------------------------------------------------------310 //--------------------------------------------------------------------------------------------------316 //--------------------------------------------------------------------------------------------------367 //--------------------------------------------------------------------------------------------------371 //--------------------------------------------------------------------------------------------------383 //--------------------------------------------------------------------------------------------------387 //--------------------------------------------------------------------------------------------------398 //--------------------------------------------------------------------------------------------------406 //--------------------------------------------------------------------------------------------------424 //--------------------------------------------------------------------------------------------------429 //--------------------------------------------------------------------------------------------------444 //--------------------------------------------------------------------------------------------------448 //--------------------------------------------------------------------------------------------------452 //--------------------------------------------------------------------------------------------------456 //--------------------------------------------------------------------------------------------------460 //--------------------------------------------------------------------------------------------------464 //--------------------------------------------------------------------------------------------------468 //--------------------------------------------------------------------------------------------------486 //--------------------------------------------------------------------------------------------------488 (496 //--------------------------------------------------------------------------------------------------504 //--------------------------------------------------------------------------------------------------506 (511 //--------------------------------------------------------------------------------------------------517 //--------------------------------------------------------------------------------------------------527 //--------------------------------------------------------------------------------------------------531 //--------------------------------------------------------------------------------------------------538 //--------------------------------------------------------------------------------------------------544 //--------------------------------------------------------------------------------------------------554 //--------------------------------------------------------------------------------------------------558 //--------------------------------------------------------------------------------------------------565 //--------------------------------------------------------------------------------------------------576 //--------------------------------------------------------------------------------------------------582 //--------------------------------------------------------------------------------------------------592 //--------------------------------------------------------------------------------------------------598 //--------------------------------------------------------------------------------------------------606 //--------------------------------------------------------------------------------------------------612 //--------------------------------------------------------------------------------------------------620 //--------------------------------------------------------------------------------------------------627 //--------------------------------------------------------------------------------------------------635 //--------------------------------------------------------------------------------------------------641 //--------------------------------------------------------------------------------------------------649 //--------------------------------------------------------------------------------------------------656 //--------------------------------------------------------------------------------------------------664 //--------------------------------------------------------------------------------------------------670 //--------------------------------------------------------------------------------------------------678 //--------------------------------------------------------------------------------------------------685 //--------------------------------------------------------------------------------------------------693 //--------------------------------------------------------------------------------------------------700 //--------------------------------------------------------------------------------------------------708 //--------------------------------------------------------------------------------------------------718 //--------------------------------------------------------------------------------------------------726 //--------------------------------------------------------------------------------------------------732 //--------------------------------------------------------------------------------------------------736 //--------------------------------------------------------------------------------------------------743 //--------------------------------------------------------------------------------------------------751 //--------------------------------------------------------------------------------------------------757 //--------------------------------------------------------------------------------------------------765 //--------------------------------------------------------------------------------------------------771 //--------------------------------------------------------------------------------------------------778 //--------------------------------------------------------------------------------------------------784 //--------------------------------------------------------------------------------------------------792 //--------------------------------------------------------------------------------------------------799 //--------------------------------------------------------------------------------------------------807 //--------------------------------------------------------------------------------------------------817 //--------------------------------------------------------------------------------------------------826 //--------------------------------------------------------------------------------------------------848 //--------------------------------------------------------------------------------------------------857 //--------------------------------------------------------------------------------------------------870 //--------------------------------------------------------------------------------------------------878 //--------------------------------------------------------------------------------------------------885 //--------------------------------------------------------------------------------------------------893 //--------------------------------------------------------------------------------------------------le_result_t le_avc_GetPollingTimer(uint32_t *pollingTimerPtr)le_result_t le_avc_SetApnConfig(const char *apnName, const char *userName, const char *userPwd)le_result_t le_avc_GetRetryTimers(uint16_t *timerValuePtr, size_t *timerValueNumElementsPtr)le_avc_SessionRequestEventHandlerRef_t le_avc_AddSessionRequestEventHandler(le_avc_SessionRequestHandlerFunc_t handlerPtr, void *contextPtr)void le_avc_RemoveSessionRequestEventHandler(le_avc_SessionRequestEventHandlerRef_t addHandlerRef)void le_avc_RemoveStatusEventHandler(le_avc_StatusEventHandlerRef_t addHandlerRef)An error occurred uninstalling the update.Definition: le_avc_interface.h:355void le_avc_UnblockInstall(le_avc_BlockRequestRef_t blockRef)le_avc_StatusEventHandlerRef_t le_avc_AddStatusEventHandler(le_avc_StatusHandlerFunc_t handlerPtr, void *contextPtr)struct le_avc_SessionRequestEventHandler * le_avc_SessionRequestEventHandlerRef_tDefinition: le_avc_interface.h:457le_result_t le_avc_DeferUninstall(uint32_t deferMinutes)Install is pending (implies download complete)Definition: le_avc_interface.h:334le_result_t le_avc_AcceptUninstall(void)le_result_t le_avc_GetUpdateType(le_avc_UpdateType_t *updateTypePtr)le_result_t le_avc_StartSession(void)le_result_t le_avc_StopSession(void)le_result_t le_avc_SetRetryTimers(const uint16_t *timerValuePtr, size_t timerValueNumElements)le_result_t le_avc_AcceptDownload(void)le_result_t le_avc_TryConnectService(void)le_result_t le_avc_DeferInstall(uint32_t deferMinutes)le_result_t le_avc_AcceptInstall(void)Something failed while doing install/download.Definition: le_avc_interface.h:415struct le_avc_BlockRequest * le_avc_BlockRequestRef_tDefinition: le_avc_interface.h:465le_avc_BlockRequestRef_t le_avc_BlockInstall(void)void le_avc_DisconnectService(void)le_avc_SessionType_t le_avc_GetSessionType(void)le_result_t le_avc_DeferDownload(uint32_t deferMinutes)le_result_t le_avc_SetPollingTimer(uint32_t pollingTimer)void(* le_avc_SessionRequestHandlerFunc_t)(le_avc_SessionRequest_t request, void *contextPtr)Definition: le_avc_interface.h:506Security check failure while installing the package.Definition: le_avc_interface.h:418void(* le_avc_StatusHandlerFunc_t)(le_avc_Status_t updateStatus, int32_t totalNumBytes, int32_t dloadProgress, void *contextPtr)Definition: le_avc_interface.h:488uint16_t le_avc_GetHttpStatus(void)struct le_avc_StatusEventHandler * le_avc_StatusEventHandlerRef_tDefinition: le_avc_interface.h:449le_result_t le_avc_GetAppUpdateName(char *updateName, size_t updateNameNumElements)le_avc_ErrorCode_t le_avc_GetErrorCode(void)le_result_t le_avc_GetApnConfig(char *apnName, size_t apnNameNumElements, char *userName, size_t userNameNumElements, char *userPwd, size_t userPwdNumElements)void le_avc_ConnectService(void)