Files | Typedefs | Enumerations | Functions

le_updateCtrl API Reference

Files

file  le_updateCtrl_common.h
 
file  le_updateCtrl_interface.h
 

Typedefs

typedef void(* le_updateCtrl_DisconnectHandler_t) (void *)
 

Enumerations

enum  le_updateCtrl_SystemState_t { LE_UPDATECTRL_SYSTEMSTATE_GOOD = 0, LE_UPDATECTRL_SYSTEMSTATE_BAD = 1, LE_UPDATECTRL_SYSTEMSTATE_PROBATION = 2 }
 

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)
 
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)
 

Detailed Description

Typedef Documentation

◆ le_updateCtrl_DisconnectHandler_t

typedef void(* le_updateCtrl_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Enumeration Type Documentation

◆ le_updateCtrl_SystemState_t

enum le_updateCtrl_SystemState_t

State of the system.

Enumerator
LE_UPDATECTRL_SYSTEMSTATE_GOOD 

"good"

LE_UPDATECTRL_SYSTEMSTATE_BAD 

"bad"

LE_UPDATECTRL_SYSTEMSTATE_PROBATION 

"tried N" or untried.

Function Documentation

◆ le_updateCtrl_Allow()

void le_updateCtrl_Allow ( void  )

Allow updates to go ahead.

◆ le_updateCtrl_ConnectService()

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

This function is created automatically.

◆ le_updateCtrl_Defer()

void le_updateCtrl_Defer ( void  )

State of the system. Prevent all updates (and roll-backs) until further notice.

◆ le_updateCtrl_DisconnectService()

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.

◆ le_updateCtrl_FailProbation()

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().

◆ le_updateCtrl_GetSystemState()

le_updateCtrl_SystemState_t le_updateCtrl_GetSystemState ( void  )

Get the current system state.

Note
Can only be called if updates have been deferred or if a probation lock is held. Otherwise the system state could change between the time this function is called and when the return value is checked.

◆ le_updateCtrl_LockProbation()

bool le_updateCtrl_LockProbation ( void  )

Prevent the probation period from ending.

Returns
false if lock failed (for example if not in a probation period).

◆ le_updateCtrl_MarkGood()

le_result_t le_updateCtrl_MarkGood ( bool  force)

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

Returns
  • LE_OK The system was marked Good
  • LE_BUSY Someone holds a probation lock
  • LE_DUPLICATE Probation has expired - the system has already been marked
Parameters
[in]forceTrue to set system Good even if someone holds a probation lock

◆ le_updateCtrl_SetServerDisconnectHandler()

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_updateCtrl_TryConnectService()

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 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_updateCtrl_UnlockProbation()

void le_updateCtrl_UnlockProbation ( void  )

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

Note
Must match previous successful call to LockProbation().