Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
#include "taf_voicecall_interface.h"
#include "taf_voicecall_messages.h"
#include "taf_voicecall_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... | |
Variables | |
static le_mem_PoolRef_t | _ClientThreadDataPool |
static pthread_key_t | _ThreadDataKey |
static bool | CommonDataInitialized = false |
le_mutex_Ref_t | le_ifgen_InitMutexRef |
#define LOCK_INIT le_mutex_Lock(le_ifgen_InitMutexRef); |
Locks the mutex.
#define UNLOCK_INIT le_mutex_Unlock(le_ifgen_InitMutexRef); |
Unlocks the mutex.
LE_MEM_DEFINE_STATIC_POOL | ( | taf_voicecall_ClientThreadData | , |
LE_CDATA_COMPONENT_COUNT | , | ||
sizeof(_ClientThreadData_t) | |||
) |
Static pool for client threads.
|
static |
Initialize thread specific data, and connect to the service for the current thread.
|
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__ | ( | (unused) | ) |
Return the sessionRef for the current thread.
If the current thread does not have a session ref, then this is a fatal error.
|
static |
Destructor function for client thread objects.
|
static |
Init data that is common across all threads.
|
static |
Connect to the service, using either blocking or non-blocking calls.
This function implements the details of the public ConnectService functions.
void taf_voicecall_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_result_t taf_voicecall_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.
|
static |
void taf_voicecall_SetServerDisconnectHandler | ( | taf_voicecall_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.
|
static |
void taf_voicecall_SetNonExitServerDisconnectHandler | ( | taf_voicecall_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.
void taf_voicecall_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_voicecall_StateHandlerRef_t taf_voicecall_AddStateHandler | ( | taf_voicecall_StateHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_voicecall_State'
[in] | handlerPtr | |
[in] | contextPtr |
void taf_voicecall_RemoveStateHandler | ( | taf_voicecall_StateHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_voicecall_State'
[in] | handlerRef |
taf_voicecall_CallRef_t taf_voicecall_Start | ( | const char *LE_NONNULL | destinationID, |
uint8_t | phoneId | ||
) |
Starts a call according to a given phone number and slot ID.
[in] | destinationID | Destination phone number for |
[in] | phoneId | SIM slot ID. |
le_result_t taf_voicecall_End | ( | taf_voicecall_CallRef_t | reference | ) |
Stops a call according to the given reference ID.
[in] | reference | The call reference. |
le_result_t taf_voicecall_Delete | ( | taf_voicecall_CallRef_t | reference | ) |
Deletes a call according to the given call reference.
[in] | reference | The call reference. |
le_result_t taf_voicecall_Answer | ( | taf_voicecall_CallRef_t | reference | ) |
Answers an incoming or a waiting call. The call reference can be retrieved from the call state handler.If a Waiting call is being answered and the existing call is Active, then the existing call will move to Hold state. If the existing call is on Hold already, then it will remain on Hold. The waiting call state transitions from Waiting to Active. If a Waiting call is being answered and the existing call is Active, then the existing call will move to Hold state. If the existing call is on Hold already, then it will remain on Hold. The waiting call state transitions from Waiting to Active.
[in] | reference | The call reference. |
le_result_t taf_voicecall_GetEndCause | ( | taf_voicecall_CallRef_t | reference, |
taf_voicecall_CallEndCause_t * | causePtr | ||
) |
Gets the call end reason according to the call reference. This call should be in the END state. The call should be in the idle state when calling this API.
[in] | reference | The call reference. |
[out] | causePtr | The end cause enumeration. |
le_result_t taf_voicecall_Hold | ( | taf_voicecall_CallRef_t | reference | ) |
Holds the active call. This call should be in the ACTIVE state.
[in] | reference | The call reference. |
le_result_t taf_voicecall_Resume | ( | taf_voicecall_CallRef_t | reference | ) |
Resumes the holding call. This call should be in the HOLD state.
[in] | reference | The call reference. |
le_result_t taf_voicecall_Swap | ( | taf_voicecall_CallRef_t | reference | ) |
Swaps calls to make one active and put the another on hold. This should be two calls, where one is in the holding state and the another is in the active state.
[in] | reference | The call reference. |
|
static |
The memory pool for client thread objects
|
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.
|
static |
This global flag is shared by all client threads, and is used to indicate whether the common data has been initialized.
le_mutex_Ref_t le_ifgen_InitMutexRef |
Mutex and associated macros for use with the above CommonDataInitialized.