le_appInfo_client.c File Reference

#include "le_appInfo_interface.h"
#include "le_appInfo_messages.h"
#include "le_appInfo_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_appInfo_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_appInfo_ConnectService (void)
le_result_t	le_appInfo_TryConnectService (void)
static void	SessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)
void	le_appInfo_SetServerDisconnectHandler (le_appInfo_DisconnectHandler_t disconnectHandler, void *contextPtr)
static void	NonExitSessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)
void	le_appInfo_SetNonExitServerDisconnectHandler (le_appInfo_DisconnectHandler_t disconnectHandler, void *contextPtr)
void	le_appInfo_DisconnectService (void)
le_appInfo_State_t	le_appInfo_GetState (const char *LE_NONNULL appName)
le_appInfo_ProcState_t	le_appInfo_GetProcState (const char *LE_NONNULL appName, const char *LE_NONNULL procName)
le_result_t	le_appInfo_GetName (int32_t pid, char *appName, size_t appNameSize)
le_result_t	le_appInfo_GetHash (const char *LE_NONNULL appName, char *hashStr, size_t hashStrSize)

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_appInfo_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_appInfo_ConnectService()

void le_appInfo_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_appInfo_TryConnectService()

le_result_t le_appInfo_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_appInfo_SetServerDisconnectHandler()

void le_appInfo_SetServerDisconnectHandler	(	le_appInfo_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_appInfo_SetNonExitServerDisconnectHandler()

void le_appInfo_SetNonExitServerDisconnectHandler	(	le_appInfo_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_appInfo_DisconnectService()

void le_appInfo_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_appInfo_GetState()

le_appInfo_State_t le_appInfo_GetState

(

const char *LE_NONNULL

appName

)

Gets the state of the specified application. The state of unknown applications is STOPPED.

Returns

The state of the specified application.

Note

If the application name pointer is null or if its string is empty or of bad format it is a fatal error, the function will not return.

Parameters

[in]

appName

Application name.

le_appInfo_GetProcState()

le_appInfo_ProcState_t le_appInfo_GetProcState	(	const char *LE_NONNULL	appName,
		const char *LE_NONNULL	procName
	)

Gets the state of the specified process in an application. This function only works for configured processes that the Supervisor starts directly.

Returns

The state of the specified process.

Note

If the application or process names pointers are null or if their strings are empty or of bad format it is a fatal error, the function will not return.

Parameters

[in]	appName	Application name.
[in]	procName	Process name.

le_appInfo_GetName()

le_result_t le_appInfo_GetName	(	int32_t	pid,
		char *	appName,
		size_t	appNameSize
	)

Gets the application name of the process with the specified PID.

Returns

LE_OK if the application name was successfully found. LE_OVERFLOW if the application name could not fit in the provided buffer. LE_NOT_FOUND if the process is not part of an application. LE_FAULT if there was an error.

Parameters

[in]	pid	PID of the process.
[out]	appName	Application name.
[in]	appNameSize

le_appInfo_GetHash()

le_result_t le_appInfo_GetHash	(	const char *LE_NONNULL	appName,
		char *	hashStr,
		size_t	hashStrSize
	)

Gets the application hash as a hexidecimal string. The application hash is a unique hash of the current version of the application.

Returns

LE_OK if the application has was successfully retrieved. LE_OVERFLOW if the application hash could not fit in the provided buffer. LE_NOT_FOUND if the application is not installed. LE_FAULT if there was an error.

Note

If the application name pointer is null or if its string is empty or of bad format it is a fatal error, the function will not return.

Parameters

[in]	appName	Application name.
[out]	hashStr	Hash string.
[in]	hashStrSize

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.