Snapdragon® Telematics Application Framework (TelAF) Interface Specification
Data Structures | Macros | Functions | Variables
taf_fsc_client.c File Reference
#include "taf_fsc_interface.h"
#include "taf_fsc_messages.h"
#include "taf_fsc_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 (taf_fsc_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 taf_fsc_ConnectService (void)
 
le_result_t taf_fsc_TryConnectService (void)
 
static void SessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)
 
void taf_fsc_SetServerDisconnectHandler (taf_fsc_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
static void NonExitSessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)
 
void taf_fsc_SetNonExitServerDisconnectHandler (taf_fsc_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void taf_fsc_DisconnectService (void)
 
taf_fsc_StorageRef_t taf_fsc_GetStorageRef (const char *LE_NONNULL dirPath, le_result_t *resultPtr)
 
le_result_t taf_fsc_LockStorage (taf_fsc_StorageRef_t StorageRef)
 
le_result_t taf_fsc_UnlockStorage (taf_fsc_StorageRef_t StorageRef)
 
le_result_t taf_fsc_DeleteStorage (taf_fsc_StorageRef_t StorageRef)
 

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

◆ taf_fsc_ConnectService()

void taf_fsc_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.

◆ taf_fsc_TryConnectService()

le_result_t taf_fsc_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

◆ taf_fsc_SetServerDisconnectHandler()

void taf_fsc_SetServerDisconnectHandler ( taf_fsc_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

◆ taf_fsc_SetNonExitServerDisconnectHandler()

void taf_fsc_SetNonExitServerDisconnectHandler ( taf_fsc_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.

◆ taf_fsc_DisconnectService()

void taf_fsc_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.

◆ taf_fsc_GetStorageRef()

taf_fsc_StorageRef_t taf_fsc_GetStorageRef ( const char *LE_NONNULL  dirPath,
le_result_t *  resultPtr 
)

Gets the FS-Crypt storage object reference, including initialization for the FS-Crypt directory.

Returns
  • Storage – The FS-Crypt storage object reference.
  • NULL – Failure in process.
Parameters
[in]dirPathStorage name.
[out]resultPtrError status.

◆ taf_fsc_LockStorage()

le_result_t taf_fsc_LockStorage ( taf_fsc_StorageRef_t  StorageRef)

Removes an FS-Crypt key from the kernel keyring to lock the directory.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter(s).
  • LE_NOT_FOUND – The key does not exist or is not provisioned.
  • LE_FAULT – Error in process.
Parameters
[in]StorageRefStorage reference.

◆ taf_fsc_UnlockStorage()

le_result_t taf_fsc_UnlockStorage ( taf_fsc_StorageRef_t  StorageRef)

Adds an FS-Crypt key to the kernel keyring to unlock the directory.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter(s).
  • LE_NOT_FOUND – Key does not exist.
  • LE_FAULT – Error in process.
Parameters
[in]StorageRefStorage reference.

◆ taf_fsc_DeleteStorage()

le_result_t taf_fsc_DeleteStorage ( taf_fsc_StorageRef_t  StorageRef)

Cleans the entire FS-Crypt directory and encryption key.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter(s).
  • LE_NOT_FOUND – Key does not exist.
  • LE_FAULT – Error in process.
Parameters
[in]StorageRefStorage reference.

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.