le_updateCtrl_client.c File Reference

#include "le_updateCtrl_interface.h"
#include "le_updateCtrl_messages.h"
#include "le_updateCtrl_service.h"

Data Structures
struct	_ClientThreadData_t

Macros
#define	LOCK_INIT   le_mutex_Lock(le_ifgen_InitMutexRef);
	Locks the mutex. More...
#define	UNLOCK_INIT   le_mutex_Unlock(le_ifgen_InitMutexRef);
	Unlocks the mutex. More...

Functions
	LE_MEM_DEFINE_STATIC_POOL (le_updateCtrl_ClientThreadData, LE_CDATA_COMPONENT_COUNT, sizeof(_ClientThreadData_t))
static le_result_t	InitClientForThread (bool isBlocking)
static _ClientThreadData_t *	GetClientThreadDataPtr (void)
	__attribute__ ((unused))
static void	ClientThreadDestructor (void *objPtr)
static void	InitCommonData (void)
static le_result_t	DoConnectService (bool isBlocking)
void	le_updateCtrl_ConnectService (void)
le_result_t	le_updateCtrl_TryConnectService (void)
static void	SessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)
void	le_updateCtrl_SetServerDisconnectHandler (le_updateCtrl_DisconnectHandler_t disconnectHandler, void *contextPtr)
static void	NonExitSessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)
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)

Variables
static le_mem_PoolRef_t	_ClientThreadDataPool
static pthread_key_t	_ThreadDataKey
static bool	CommonDataInitialized = false
le_mutex_Ref_t	le_ifgen_InitMutexRef

Macro Definition Documentation

LOCK_INIT

#define LOCK_INIT   le_mutex_Lock(le_ifgen_InitMutexRef);

Locks the mutex.

UNLOCK_INIT

#define UNLOCK_INIT   le_mutex_Unlock(le_ifgen_InitMutexRef);

Unlocks the mutex.

Function Documentation

LE_MEM_DEFINE_STATIC_POOL()

LE_MEM_DEFINE_STATIC_POOL	(	le_updateCtrl_ClientThreadData	,
		LE_CDATA_COMPONENT_COUNT	,
		sizeof(_ClientThreadData_t)
	)

Static pool for client threads.

InitClientForThread()

static le_result_t InitClientForThread ( bool  isBlocking )

static

Initialize thread specific data, and connect to the service for the current thread.

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.

GetClientThreadDataPtr()

static _ClientThreadData_t* GetClientThreadDataPtr ( void  )

static

Get a pointer to the client thread data for the current thread.

If the current thread does not have client data, then NULL is returned

__attribute__()

__attribute__

(

(unused)

)

Return the sessionRef for the current thread.

If the current thread does not have a session ref, then this is a fatal error.

ClientThreadDestructor()

static void ClientThreadDestructor ( void *  objPtr )

static

Destructor function for client thread objects.

InitCommonData()

static void InitCommonData ( void  )

static

Init data that is common across all threads.

DoConnectService()

static le_result_t DoConnectService ( bool  isBlocking )

static

Connect to the service, using either blocking or non-blocking calls.

This function implements the details of the public ConnectService functions.

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_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 apiFilesC_client.

This function is created automatically.

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 apiFilesC_client.

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.

SessionCloseHandler()

static void SessionCloseHandler ( le_msg_SessionRef_t  sessionRef, void *  contextPtr  )

static

le_updateCtrl_SetServerDisconnectHandler()

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.

NonExitSessionCloseHandler()

static void NonExitSessionCloseHandler ( le_msg_SessionRef_t  sessionRef, void *  contextPtr  )

static

le_updateCtrl_SetNonExitServerDisconnectHandler()

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.

Warning

When using the API, it needs the application developer to handle some cases like re-connecting and recycling the resources. For most of cases, it is safe to use SetServerDisconnectHandler.

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 apiFilesC_client.

This function is created automatically.

le_updateCtrl_Defer()

void le_updateCtrl_Defer

(

void

)

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

le_updateCtrl_Allow()

void le_updateCtrl_Allow

(

void

)

Allow updates to go ahead.

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

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]

force

True to set system Good even if someone holds a probation lock

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.

Variable Documentation

_ClientThreadDataPool

le_mem_PoolRef_t _ClientThreadDataPool

static

The memory pool for client thread objects

_ThreadDataKey

pthread_key_t _ThreadDataKey

static

Key under which the pointer to the Thread Object (_ClientThreadData_t) will be kept in thread-local storage. This allows a thread to quickly get a pointer to its own Thread Object.

CommonDataInitialized

bool CommonDataInitialized = false

static

This global flag is shared by all client threads, and is used to indicate whether the common data has been initialized.

Warning

Use InitMutex, defined below, to protect accesses to this data.

le_ifgen_InitMutexRef

le_mutex_Ref_t le_ifgen_InitMutexRef

Mutex and associated macros for use with the above CommonDataInitialized.