Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
Go to the source code of this file.
Typedefs | |
typedef void(* | le_updateCtrl_DisconnectHandler_t) (void *) |
Functions | |
void | le_updateCtrl_ConnectService (void) |
le_result_t | le_updateCtrl_TryConnectService (void) |
LE_FULL_API void | le_updateCtrl_SetServerDisconnectHandler (le_updateCtrl_DisconnectHandler_t disconnectHandler, void *contextPtr) |
LE_FULL_API void | le_updateCtrl_SetNonExitServerDisconnectHandler (le_updateCtrl_DisconnectHandler_t disconnectHandler, void *contextPtr) |
void | le_updateCtrl_DisconnectService (void) |
void | le_updateCtrl_Defer (void) |
void | le_updateCtrl_Allow (void) |
bool | le_updateCtrl_LockProbation (void) |
void | le_updateCtrl_UnlockProbation (void) |
le_result_t | le_updateCtrl_MarkGood (bool force) |
void | le_updateCtrl_FailProbation (void) |
le_updateCtrl_SystemState_t | le_updateCtrl_GetSystemState (void) |
Legato Update Control API include file.
Copyright (C) Sierra Wireless Inc.
typedef void(* le_updateCtrl_DisconnectHandler_t) (void *) |
Type for handler called when a server disconnects.
void le_updateCtrl_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_updateCtrl_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_updateCtrl_SetServerDisconnectHandler | ( | le_updateCtrl_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_updateCtrl_SetNonExitServerDisconnectHandler | ( | le_updateCtrl_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_updateCtrl_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.
void le_updateCtrl_Defer | ( | void | ) |
Prevent all updates (and roll-backs) until further notice.
void le_updateCtrl_Allow | ( | void | ) |
Allow updates to go ahead.
bool le_updateCtrl_LockProbation | ( | void | ) |
Prevent the probation period from ending.
void le_updateCtrl_UnlockProbation | ( | void | ) |
Cancels a call to LockProbation(), allow the probation period to end.
le_result_t le_updateCtrl_MarkGood | ( | bool | force | ) |
Marks the system "good", ending the probation period.
[in] | force | True to set system Good even if someone holds a probation lock |
void le_updateCtrl_FailProbation | ( | void | ) |
Marks the system "bad" and triggers a roll-back to a "good" system.
le_updateCtrl_SystemState_t le_updateCtrl_GetSystemState | ( | void | ) |
Get the current system state.