le_avc_interface.h File Reference

#include "legato.h"
#include "le_limit_interface.h"
#include "le_avc_common.h"

Go to the source code of this file.

Typedefs

typedef void(* le_avc_DisconnectHandler_t) (void *)
 

Functions

void le_avc_ConnectService (void)
 
le_result_t le_avc_TryConnectService (void)
 
LE_FULL_API void le_avc_SetServerDisconnectHandler (le_avc_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
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 handlerRef)
 
le_avc_SessionRequestEventHandlerRef_t le_avc_AddSessionRequestEventHandler (le_avc_SessionRequestHandlerFunc_t handlerPtr, void *contextPtr)
 
void le_avc_RemoveSessionRequestEventHandler (le_avc_SessionRequestEventHandlerRef_t handlerRef)
 
le_avc_CommInfoHandlerRef_t le_avc_AddCommInfoHandler (le_avc_CommInfoHandlerFunc_t handlerPtr, void *contextPtr)
 
void le_avc_RemoveCommInfoHandler (le_avc_CommInfoHandlerRef_t handlerRef)
 
le_result_t le_avc_StartSession (void)
 
le_result_t le_avc_StopSession (void)
 
le_result_t le_avc_CheckRoute (void)
 
le_result_t le_avc_DeferConnect (uint32_t deferMinutes)
 
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_AcceptReboot (void)
 
le_result_t le_avc_DeferReboot (uint32_t deferMinutes)
 
le_result_t le_avc_GetUpdateType (le_avc_UpdateType_t *updateTypePtr)
 
le_result_t le_avc_GetAppUpdateName (char *updateName, size_t updateNameSize)
 
le_avc_BlockRequestRef_t le_avc_BlockInstall (void)
 
void le_avc_UnblockInstall (le_avc_BlockRequestRef_t blockRef)
 
le_avc_ErrorCode_t le_avc_GetErrorCode (void)
 
le_avc_SessionType_t le_avc_GetSessionType (void)
 
uint16_t le_avc_GetHttpStatus (void)
 
le_result_t le_avc_GetPollingTimer (uint32_t *pollingTimerPtr)
 
le_result_t le_avc_GetRetryTimers (uint16_t *timerValuePtr, size_t *timerValueSizePtr)
 
le_result_t le_avc_GetApnConfig (char *apnName, size_t apnNameSize, char *userName, size_t userNameSize, char *userPwd, size_t userPwdSize)
 
le_result_t le_avc_SetApnConfig (const char *LE_NONNULL apnName, const char *LE_NONNULL userName, const char *LE_NONNULL userPwd)
 
le_result_t le_avc_SetPollingTimer (uint32_t pollingTimer)
 
le_result_t le_avc_SetRetryTimers (const uint16_t *timerValuePtr, size_t timerValueSize)
 
le_avc_CredentialStatus_t le_avc_GetCredentialStatus (void)
 
le_result_t le_avc_SetUserAgreement (le_avc_UserAgreement_t updateStatus, bool enable)
 
le_result_t le_avc_GetUserAgreement (le_avc_UserAgreement_t updateStatus, bool *enablePtr)
 
le_result_t le_avc_ReadLwm2mResource (uint16_t objectId, uint16_t objectInstanceId, uint16_t resourceId, uint16_t resourceInstanceId, char *data, size_t dataSize)
 

Detailed Description

Legato AirVantage Connector API include file.

Typedef Documentation

◆ le_avc_DisconnectHandler_t

typedef void(* le_avc_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

◆ le_avc_AcceptDownload()

le_result_t le_avc_AcceptDownload ( void  )

Accept the currently pending download

Returns
  • LE_OK on success
  • LE_FAULT on failure

◆ le_avc_AcceptInstall()

le_result_t le_avc_AcceptInstall ( void  )

Accept the currently pending install

Returns
  • LE_OK on success
  • LE_FAULT on failure

◆ le_avc_AcceptReboot()

le_result_t le_avc_AcceptReboot ( void  )

Accept the currently pending reboot

Note
When this function is called, a 2-second timer is launched and the reboot function is called when the timer expires.
Returns
  • LE_OK on success
  • LE_FAULT on failure

◆ le_avc_AcceptUninstall()

le_result_t le_avc_AcceptUninstall ( void  )

Accept the currently pending uninstall

Returns
  • LE_OK on success
  • LE_FAULT on failure

◆ le_avc_AddCommInfoHandler()

le_avc_CommInfoHandlerRef_t le_avc_AddCommInfoHandler ( le_avc_CommInfoHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'le_avc_CommInfo'

This event provides communication errors.

Parameters
[in]handlerPtr
[in]contextPtr

◆ le_avc_AddSessionRequestEventHandler()

le_avc_SessionRequestEventHandlerRef_t le_avc_AddSessionRequestEventHandler ( le_avc_SessionRequestHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'le_avc_SessionRequestEvent'

This event provides information on session open or close request.

Parameters
[in]handlerPtr
[in]contextPtr

◆ le_avc_AddStatusEventHandler()

le_avc_StatusEventHandlerRef_t le_avc_AddStatusEventHandler ( le_avc_StatusHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Status of session or update

If an update is pending, it must first be downloaded and then installed. Operations which require user agreement Request to open or close avms session. The type of pending update Error code used to provide diagnostic information after a failure (includes both download and install failure).

Note
Additional information may also be available in the target device's system log. Session type indicates whether the device is connected to the bootstrap server or the device management server. Status of the device credentials Handler for update availability status Reference type used by Add/Remove functions for EVENT 'le_avc_StatusEvent' Handler for receiving session open or close request. Reference type used by Add/Remove functions for EVENT 'le_avc_SessionRequestEvent' Handler for receiving communication information. Reference type used by Add/Remove functions for EVENT 'le_avc_CommInfo' Reference returned by BlockInstall function and used by UnblockInstall function Add handler function for EVENT 'le_avc_StatusEvent'

This event provides information on update availability status

Parameters
[in]handlerPtr
[in]contextPtr

◆ le_avc_BlockInstall()

le_avc_BlockRequestRef_t le_avc_BlockInstall ( void  )

Prevent any pending updates from being installed.

Returns
  • Reference for block update request (to be used later for unblocking updates)
  • NULL if the operation was not successful

◆ le_avc_CheckRoute()

le_result_t le_avc_CheckRoute ( void  )

Send a specific message to the server to be sure that the route between the device and the server is available. This API needs to be called when any package download is over (successfully or not) and before sending any notification on asset data to the server.

Returns
  • LE_OK when the treatment is launched
  • LE_FAULT on failure
  • LE_UNSUPPORTED when the API is not supported

◆ le_avc_ConnectService()

void le_avc_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 Client-specific Functions.

This function is created automatically.

◆ le_avc_DeferConnect()

le_result_t le_avc_DeferConnect ( uint32_t  deferMinutes)

Defer the currently pending connection, for the given number of minutes

Returns
  • LE_OK on success
  • LE_FAULT on failure
Parameters
[in]deferMinutes

◆ le_avc_DeferDownload()

le_result_t le_avc_DeferDownload ( uint32_t  deferMinutes)

Defer the currently pending download, for the given number of minutes

Returns
  • LE_OK on success
  • LE_FAULT on failure
Parameters
[in]deferMinutes

◆ le_avc_DeferInstall()

le_result_t le_avc_DeferInstall ( uint32_t  deferMinutes)

Defer the currently pending install

Returns
  • LE_OK on success
  • LE_FAULT on failure
Parameters
[in]deferMinutes

◆ le_avc_DeferReboot()

le_result_t le_avc_DeferReboot ( uint32_t  deferMinutes)

Defer the currently pending reboot

Returns
  • LE_OK on success
  • LE_FAULT on failure
Parameters
[in]deferMinutes

◆ le_avc_DeferUninstall()

le_result_t le_avc_DeferUninstall ( uint32_t  deferMinutes)

Defer the currently pending uninstall

Returns
  • LE_OK on success
  • LE_FAULT on failure
Parameters
[in]deferMinutes

◆ le_avc_DisconnectService()

void le_avc_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 Client-specific Functions.

This function is created automatically.

◆ le_avc_GetApnConfig()

le_result_t le_avc_GetApnConfig ( char *  apnName,
size_t  apnNameSize,
char *  userName,
size_t  userNameSize,
char *  userPwd,
size_t  userPwdSize 
)

Function to read APN configuration.

Returns
  • LE_OK on success.
  • LE_FAULT if there is any error while reading.
  • LE_OVERFLOW if the buffer provided is too small.
Parameters
[out]apnName
[in]apnNameSize
[out]userName
[in]userNameSize
[out]userPwd
[in]userPwdSize

◆ le_avc_GetAppUpdateName()

le_result_t le_avc_GetAppUpdateName ( char *  updateName,
size_t  updateNameSize 
)

Get the name for the currently pending app update

Returns
  • LE_OK on success
  • LE_FAULT if not available, or isn't APPL_UPDATE type
Parameters
[out]updateName
[in]updateNameSize

◆ le_avc_GetCredentialStatus()

le_avc_CredentialStatus_t le_avc_GetCredentialStatus ( void  )

Function to retrieve status of the credentials provisioned on the device.

Returns
LE_AVC_NO_CREDENTIAL_PROVISIONED
  • If neither Bootstrap nor Device Management credential is provisioned. LE_AVC_BS_CREDENTIAL_PROVISIONED
  • If Bootstrap credential is provisioned but Device Management credential is not provisioned. LE_AVC_DM_CREDENTIAL_PROVISIONED
  • If Device management key is provisioned.

◆ le_avc_GetErrorCode()

le_avc_ErrorCode_t le_avc_GetErrorCode ( void  )

Function to get error code when update fails.

Returns
  • Error code of encountered error.
  • ERR_NONE if update is in any other state.

◆ le_avc_GetHttpStatus()

uint16_t le_avc_GetHttpStatus ( void  )

Function to read the http status of the last download.

Returns
  • HttpStatus as defined in RFC 7231, Section 6.

◆ le_avc_GetPollingTimer()

le_result_t le_avc_GetPollingTimer ( uint32_t *  pollingTimerPtr)

Function to read the polling timer.

Returns
  • LE_OK on success
  • LE_FAULT if not available
  • LE_OUT_OF_RANGE if the polling timer value is out of range (0 to 525600).
Parameters
[out]pollingTimerPtrPolling timer interval, minutes

◆ le_avc_GetRetryTimers()

le_result_t le_avc_GetRetryTimers ( uint16_t *  timerValuePtr,
size_t *  timerValueSizePtr 
)

Function to read the retry timers.

Returns
  • LE_OK on success.
  • LE_FAULT if not able to read the timers.
  • LE_OUT_OF_RANGE if one of the retry timers is out of range (0 to 20160).
Parameters
[out]timerValuePtrArray of retry timer intervals, minutes.
[in,out]timerValueSizePtr

◆ le_avc_GetSessionType()

le_avc_SessionType_t le_avc_GetSessionType ( void  )

Function to read the current session type, or the last session type if there is no active session.

Returns
  • SessionType

◆ le_avc_GetUpdateType()

le_result_t le_avc_GetUpdateType ( le_avc_UpdateType_t *  updateTypePtr)

Get the update type of the currently pending update

Returns
  • LE_OK on success
  • LE_FAULT if not available
Parameters
[out]updateTypePtr

◆ le_avc_GetUserAgreement()

le_result_t le_avc_GetUserAgreement ( le_avc_UserAgreement_t  updateStatus,
bool *  enablePtr 
)

Function to get user agreements for download, install, reboot, connection and uninstall.

Returns
  • LE_OK on success.
  • LE_FAULT if failed to read user agreement state.
Parameters
[in]updateStatusOperation for which user agreements has to be read.
[out]enablePtrtrue = enable, false = disable.

◆ le_avc_ReadLwm2mResource()

le_result_t le_avc_ReadLwm2mResource ( uint16_t  objectId,
uint16_t  objectInstanceId,
uint16_t  resourceId,
uint16_t  resourceInstanceId,
char *  data,
size_t  dataSize 
)

Function to read a resource from a LWM2M object

Returns
  • LE_OK on success.
  • LE_FAULT if failed.
  • LE_UNSUPPORTED if unsupported.
Parameters
[in]objectIdObject identifier
[in]objectInstanceIdObject instance identifier
[in]resourceIdResource identifier
[in]resourceInstanceIdResource instance identifier
[out]dataString of requested resources to be read
[in]dataSize

◆ le_avc_RemoveCommInfoHandler()

void le_avc_RemoveCommInfoHandler ( le_avc_CommInfoHandlerRef_t  handlerRef)

Remove handler function for EVENT 'le_avc_CommInfo'

Parameters
[in]handlerRef

◆ le_avc_RemoveSessionRequestEventHandler()

void le_avc_RemoveSessionRequestEventHandler ( le_avc_SessionRequestEventHandlerRef_t  handlerRef)

Remove handler function for EVENT 'le_avc_SessionRequestEvent'

Parameters
[in]handlerRef

◆ le_avc_RemoveStatusEventHandler()

void le_avc_RemoveStatusEventHandler ( le_avc_StatusEventHandlerRef_t  handlerRef)

Remove handler function for EVENT 'le_avc_StatusEvent'

Parameters
[in]handlerRef

◆ le_avc_SetApnConfig()

le_result_t le_avc_SetApnConfig ( const char *LE_NONNULL  apnName,
const char *LE_NONNULL  userName,
const char *LE_NONNULL  userPwd 
)

Function to write APN configuration.

Returns
  • LE_OK on success.
  • LE_OVERFLOW if one of the input strings is too long.
Parameters
[in]apnName
[in]userName
[in]userPwd

◆ le_avc_SetPollingTimer()

le_result_t le_avc_SetPollingTimer ( uint32_t  pollingTimer)

Function to set the polling timer to a value in minutes.

Returns
  • LE_OK on success.
  • LE_OUT_OF_RANGE if the polling timer value is out of range (0 to 525600).
Parameters
[in]pollingTimerPolling timer interval, minutes

◆ le_avc_SetRetryTimers()

le_result_t le_avc_SetRetryTimers ( const uint16_t *  timerValuePtr,
size_t  timerValueSize 
)

Function to set the retry timers.

Returns
  • LE_OK on success.
  • LE_FAULT if not able to set the timers.
  • LE_OUT_OF_RANGE if one of the retry timers is out of range (0 to 20160).
Parameters
[in]timerValuePtrArray of retry timer intervals, minutes.
[in]timerValueSize

◆ le_avc_SetServerDisconnectHandler()

LE_FULL_API void le_avc_SetServerDisconnectHandler ( le_avc_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_avc_SetUserAgreement()

le_result_t le_avc_SetUserAgreement ( le_avc_UserAgreement_t  updateStatus,
bool  enable 
)

Function to set user agreements for download, install, reboot, connection and uninstall.

Returns
  • LE_OK on success.
  • LE_FAULT if failed to configure user agreement.
Parameters
[in]updateStatusOperation for which user agreements has to be set.
[in]enabletrue = enable, false = disable.

◆ le_avc_StartSession()

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.

Returns
  • LE_OK if connection request has been sent.
  • LE_FAULT on failure
  • LE_DUPLICATE if already connected.

◆ le_avc_StopSession()

le_result_t le_avc_StopSession ( void  )

Stop a session with the AirVantage server

If a download is in progress and the user agreement is enabled, this suspends the download, otherwise if the user agreement is disabled, a new connection is automatically initiated in order to resume the download.

Returns
  • LE_OK on success
  • LE_FAULT on failure
  • LE_DUPLICATE if already disconnected

◆ le_avc_TryConnectService()

le_result_t le_avc_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 Client-specific Functions.

This function is created automatically.

Returns
  • LE_OK if the client connected successfully to the service.
  • LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
  • LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
  • LE_COMM_ERROR if the Service Directory cannot be reached.

◆ le_avc_UnblockInstall()

void le_avc_UnblockInstall ( le_avc_BlockRequestRef_t  blockRef)

Allow any pending updates to be installed

Parameters
[in]blockRefblock request ref returned by le_avc_BlockInstall