le_updateCtrl_interface.h File Reference
#include "legato.h"

Go to the source code of this file.

Functions

void le_updateCtrl_ConnectService (void)
 
void le_updateCtrl_DisconnectService (void)
 
void le_updateCtrl_Defer (void)
 
void le_updateCtrl_Allow (void)
 
void le_updateCtrl_LockProbation (void)
 
void le_updateCtrl_UnlockProbation (void)
 
void le_updateCtrl_MarkGood (void)
 
void le_updateCtrl_FailProbation (void)
 

Detailed Description

Legato Update Control API include file.

Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.

Function Documentation

void le_updateCtrl_Allow ( void  )

Allow updates to go ahead.

void le_updateCtrl_ConnectService ( void  )

Connect the current client thread to the service providing this API.

This function must be called before any other functions in this API. Normally, it's automatically called for the main thread, but must be explicitly called for other threads. For details, see Client-specific Functions.

This function is created automatically.

void le_updateCtrl_Defer ( void  )

Prevent all updates (and roll-backs) until further notice.

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

This function is created automatically.

void le_updateCtrl_FailProbation ( void  )

Marks the system "bad" and triggers a roll-back to a "good" system.

Note
Ignored if the probation period has already ended. Also, the roll-back may be delayed if someone is deferring updates using le_updateCtrl_Defer().
void le_updateCtrl_LockProbation ( void  )

Prevent the probation period from ending.

Note
Ignored if the probation period has already ended.
void le_updateCtrl_MarkGood ( void  )

Marks the system "good", ending the probation period.

Note
Ignored if the probation period has already ended.
void le_updateCtrl_UnlockProbation ( void  )

Cancels a call to LockProbation(), allow the probation period to end.

Note
Ignored if the probation period has already ended.