le_update_client.c File Reference

#include "le_update_interface.h"
#include "le_update_messages.h"
#include "le_update_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_update_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_update_ConnectService (void)
le_result_t	le_update_TryConnectService (void)
static void	SessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)
void	le_update_SetServerDisconnectHandler (le_update_DisconnectHandler_t disconnectHandler, void *contextPtr)
static void	NonExitSessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)
void	le_update_SetNonExitServerDisconnectHandler (le_update_DisconnectHandler_t disconnectHandler, void *contextPtr)
void	le_update_DisconnectService (void)
le_update_ProgressHandlerRef_t	le_update_AddProgressHandler (le_update_ProgressHandlerFunc_t handlerPtr, void *contextPtr)
void	le_update_RemoveProgressHandler (le_update_ProgressHandlerRef_t handlerRef)
le_result_t	le_update_Start (int fd)
le_result_t	le_update_Install (void)
void	le_update_End (void)
le_update_ErrorCode_t	le_update_GetErrorCode (void)
int32_t	le_update_GetCurrentSysIndex (void)
le_result_t	le_update_GetSystemHash (int32_t systemIndex, char *hashStr, size_t hashStrSize)
int32_t	le_update_GetPreviousSystemIndex (int32_t systemIndex)

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_update_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_update_ConnectService()

void le_update_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_update_TryConnectService()

le_result_t le_update_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_update_SetServerDisconnectHandler()

void le_update_SetServerDisconnectHandler	(	le_update_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_update_SetNonExitServerDisconnectHandler()

void le_update_SetNonExitServerDisconnectHandler	(	le_update_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_update_DisconnectService()

void le_update_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_update_AddProgressHandler()

le_update_ProgressHandlerRef_t le_update_AddProgressHandler	(	le_update_ProgressHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'le_update_Progress'

Register for notification of the progress of a given update.

Parameters

[in]	handlerPtr	Progress handler
[in]	contextPtr

le_update_RemoveProgressHandler()

void le_update_RemoveProgressHandler

(

le_update_ProgressHandlerRef_t

handlerRef

)

Remove handler function for EVENT 'le_update_Progress'

Parameters

[in]

handlerRef

le_update_Start()

le_result_t le_update_Start

(

int

fd

)

Starts an update.

Progress is reported via the progress handler callback.

Returns

• LE_OK if accepted.
• LE_BUSY if another update is in progress.
• LE_UNAVAILABLE if the system is still in "probation" (not marked "good" yet).

Parameters

[in]

fd

Open file descriptor from which the update can be read.

le_update_Install()

le_result_t le_update_Install

(

void

)

Install the update

Returns

• LE_OK if installation started.
• LE_BUSY if package download is not finished yet.
• LE_FAULT if there is an error. Check logs

le_update_End()

void le_update_End

(

void

)

Ends an update session. If the update isn't finished yet, cancels it.

le_update_GetErrorCode()

le_update_ErrorCode_t le_update_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_update_GetCurrentSysIndex()

int32_t le_update_GetCurrentSysIndex

(

void

)

Get the index of the currently running system.

Returns

The index of the running system.

le_update_GetSystemHash()

le_result_t le_update_GetSystemHash	(	int32_t	systemIndex,
		char *	hashStr,
		size_t	hashStrSize
	)

Gets the hash ID for a given system.

Returns

• LE_OK if no problems are encountered.
• LE_NOT_FOUND if the given index does not correspond to an available system.
• LE_OVERFLOW if the supplied buffer is too small.
• LE_FORMAT_ERROR if there are problems reading the hash for the system.

Parameters

[in]	systemIndex	The system to read the hash for.
[out]	hashStr	Buffer to hold the system hash string.
[in]	hashStrSize

le_update_GetPreviousSystemIndex()

int32_t le_update_GetPreviousSystemIndex

(

int32_t

systemIndex

)

Get the index for the previous system in the chain, using the current system as a starting point.

Returns

The index to the system that's previous to the given system. -1 is returned if the previous system was not found.

Parameters

[in]

systemIndex

Get the system that's older than this system.

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.