Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
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_locPos_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_locPos_ConnectService (void) |
le_result_t | taf_locPos_TryConnectService (void) |
static void | SessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr) |
void | taf_locPos_SetServerDisconnectHandler (taf_locPos_DisconnectHandler_t disconnectHandler, void *contextPtr) |
static void | NonExitSessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr) |
void | taf_locPos_SetNonExitServerDisconnectHandler (taf_locPos_DisconnectHandler_t disconnectHandler, void *contextPtr) |
void | taf_locPos_DisconnectService (void) |
taf_locPos_MovementHandlerRef_t | taf_locPos_AddMovementHandler (uint32_t horizontalMagnitude, uint32_t verticalMagnitude, taf_locPos_MovementHandlerFunc_t handlerPtr, void *contextPtr) |
void | taf_locPos_RemoveMovementHandler (taf_locPos_MovementHandlerRef_t handlerRef) |
le_result_t | taf_locPos_Get2DLocation (int32_t *latitudePtr, int32_t *longitudePtr, int32_t *hAccuracyPtr) |
le_result_t | taf_locPos_GetDate (uint16_t *yearPtr, uint16_t *monthPtr, uint16_t *dayPtr) |
le_result_t | taf_locPos_GetFixState (taf_locGnss_FixState_t *statePtr) |
le_result_t | taf_locPos_GetMotion (uint32_t *hSpeedPtr, uint32_t *hSpeedAccuracyPtr, int32_t *vSpeedPtr, int32_t *vSpeedAccuracyPtr) |
le_result_t | taf_locPos_GetDirection (uint32_t *directionPtr, uint32_t *directionAccuracyPtr) |
le_result_t | taf_locPos_GetTime (uint16_t *hoursPtr, uint16_t *minutesPtr, uint16_t *secondsPtr, uint16_t *millisecondsPtr) |
le_result_t | taf_locPos_SetAcquisitionRate (uint32_t acquisitionRate) |
uint32_t | taf_locPos_GetAcquisitionRate (void) |
void | taf_locPos_sample_Release (taf_locPos_SampleRef_t positionSampleRef) |
le_result_t | taf_locPos_Get3DLocation (int32_t *latitudePtr, int32_t *longitudePtr, int32_t *hAccuracyPtr, int32_t *altitudePtr, int32_t *vAccuracyPtr) |
le_result_t | taf_locPos_sample_Get2DLocation (taf_locPos_SampleRef_t positionSampleRef, int32_t *latitudePtr, int32_t *longitudePtr, int32_t *horizontalAccuracyPtr) |
le_result_t | taf_locPos_sample_GetAltitude (taf_locPos_SampleRef_t positionSampleRef, int32_t *altitudePtr, int32_t *altitudeAccuracyPtr) |
le_result_t | taf_locPos_sample_GetTime (taf_locPos_SampleRef_t positionSampleRef, uint16_t *hoursPtr, uint16_t *minutesPtr, uint16_t *secondsPtr, uint16_t *millisecondsPtr) |
le_result_t | taf_locPos_sample_GetHorizontalSpeed (taf_locPos_SampleRef_t positionSampleRef, uint32_t *hSpeedPtr, uint32_t *hSpeedAccuracyPtr) |
le_result_t | taf_locPos_sample_GetDirection (taf_locPos_SampleRef_t positionSampleRef, uint32_t *directionPtr, uint32_t *directionAccuracyPtr) |
le_result_t | taf_locPos_sample_GetVerticalSpeed (taf_locPos_SampleRef_t positionSampleRef, int32_t *vspeedPtr, int32_t *vspeedAccuracyPtr) |
le_result_t | taf_locPos_SetDistanceResolution (taf_locPos_Resolution_t resolution) |
le_result_t | taf_locPos_sample_GetFixState (taf_locPos_SampleRef_t positionSampleRef, taf_locGnss_FixState_t *statePtr) |
le_result_t | taf_locPos_sample_GetDate (taf_locPos_SampleRef_t positionSampleRef, uint16_t *yearPtr, uint16_t *monthPtr, uint16_t *dayPtr) |
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_locPos_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_locPos_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_locPos_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_locPos_SetServerDisconnectHandler | ( | taf_locPos_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_locPos_SetNonExitServerDisconnectHandler | ( | taf_locPos_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_locPos_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_locPos_MovementHandlerRef_t taf_locPos_AddMovementHandler | ( | uint32_t | horizontalMagnitude, |
uint32_t | verticalMagnitude, | ||
taf_locPos_MovementHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_locPos_Movement'
This event provides information on movement changes.
[in] | horizontalMagnitude | Horizontal magnitude in meters. |
[in] | verticalMagnitude | Vertical magnitude in meters. |
[in] | handlerPtr | |
[in] | contextPtr |
void taf_locPos_RemoveMovementHandler | ( | taf_locPos_MovementHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_locPos_Movement'
[in] | handlerRef |
le_result_t taf_locPos_Get2DLocation | ( | int32_t * | latitudePtr, |
int32_t * | longitudePtr, | ||
int32_t * | hAccuracyPtr | ||
) |
Gets the 2D location data (latitude, longitude, horizontal accuracy).
[out] | latitudePtr | WGS84 latitude in degrees. |
[out] | longitudePtr | WGS84 longitude in degrees. |
[out] | hAccuracyPtr | Horizontal accuracy in meters by default. |
le_result_t taf_locPos_GetDate | ( | uint16_t * | yearPtr, |
uint16_t * | monthPtr, | ||
uint16_t * | dayPtr | ||
) |
Gets the date of the last updated location.
[out] | yearPtr | UTC Year A.D., e.g. 2014. |
[out] | monthPtr | UTC Month into the year; range is 1 to 12. |
[out] | dayPtr | UTC Days into the month; range is 1 to 31. |
le_result_t taf_locPos_GetFixState | ( | taf_locGnss_FixState_t * | statePtr | ) |
Gets the position fix state.
[out] | statePtr | Position fix state. |
le_result_t taf_locPos_GetMotion | ( | uint32_t * | hSpeedPtr, |
uint32_t * | hSpeedAccuracyPtr, | ||
int32_t * | vSpeedPtr, | ||
int32_t * | vSpeedAccuracyPtr | ||
) |
Gets the motion data (horizontal speed, horizontal speed accuracy, vertical speed, and vertical speed accuracy).
[out] | hSpeedPtr | Horizontal speed in m/sec. |
[out] | hSpeedAccuracyPtr | Horizontal speed accuracy in m/sec. |
[out] | vSpeedPtr | Vertical speed in m/sec. |
[out] | vSpeedAccuracyPtr | Vertical speed accuracy in m/sec. |
le_result_t taf_locPos_GetDirection | ( | uint32_t * | directionPtr, |
uint32_t * | directionAccuracyPtr | ||
) |
Gets the position sample's direction. Direction of movement is the direction that the vehicle or person is actually moving.
[out] | directionPtr | Direction indication in degrees; range is 0 to 359. |
[out] | directionAccuracyPtr | Direction's accuracy estimation in degrees. |
le_result_t taf_locPos_GetTime | ( | uint16_t * | hoursPtr, |
uint16_t * | minutesPtr, | ||
uint16_t * | secondsPtr, | ||
uint16_t * | millisecondsPtr | ||
) |
Gets the position sample's time.
[out] | hoursPtr | UTC Hours of the day; range is 0 to 23. |
[out] | minutesPtr | UTC Minutes of the hour; range is 0 to 59. |
[out] | secondsPtr | UTC Seconds of the minute; range is 0 to 59. |
[out] | millisecondsPtr | UTC Milliseconds of the second; range is 0 to 999. |
le_result_t taf_locPos_SetAcquisitionRate | ( | uint32_t | acquisitionRate | ) |
Sets the acquisition rate.
[in] | acquisitionRate | Acquisition Rate in milliseconds. |
uint32_t taf_locPos_GetAcquisitionRate | ( | void | ) |
Retrieves the acquisition rate in milliseconds.
void taf_locPos_sample_Release | ( | taf_locPos_SampleRef_t | positionSampleRef | ) |
Releases the position sample.
[in] | positionSampleRef | Position sample reference. |
le_result_t taf_locPos_Get3DLocation | ( | int32_t * | latitudePtr, |
int32_t * | longitudePtr, | ||
int32_t * | hAccuracyPtr, | ||
int32_t * | altitudePtr, | ||
int32_t * | vAccuracyPtr | ||
) |
Gets the 3D location data (latitude, longitude, altitude, horizontal accuracy, vertical accuracy)
[out] | latitudePtr | WGS84 Latitude in degrees. |
[out] | longitudePtr | WGS84 Longitude in degrees. |
[out] | hAccuracyPtr | Horizontal accuracy in meters by default. |
[out] | altitudePtr | Altitude above mean sea level in meters by default. |
[out] | vAccuracyPtr | Vertical accuracy in meters by default. |
le_result_t taf_locPos_sample_Get2DLocation | ( | taf_locPos_SampleRef_t | positionSampleRef, |
int32_t * | latitudePtr, | ||
int32_t * | longitudePtr, | ||
int32_t * | horizontalAccuracyPtr | ||
) |
Gets the position sample's 2D location (latitude, longitude, horizontal accuracy)
[in] | positionSampleRef | Position sample reference. |
[out] | latitudePtr | WGS84 latitude in degrees. |
[out] | longitudePtr | WGS84 longitude in degrees. |
[out] | horizontalAccuracyPtr | Horizontal accuracy in meters by default. |
le_result_t taf_locPos_sample_GetAltitude | ( | taf_locPos_SampleRef_t | positionSampleRef, |
int32_t * | altitudePtr, | ||
int32_t * | altitudeAccuracyPtr | ||
) |
Gets the position sample's altitude.
[in] | positionSampleRef | Position sample reference. |
[out] | altitudePtr | Altitude above mean sea level in meters by default. |
[out] | altitudeAccuracyPtr | Vertical accuracy in meters by default. |
le_result_t taf_locPos_sample_GetTime | ( | taf_locPos_SampleRef_t | positionSampleRef, |
uint16_t * | hoursPtr, | ||
uint16_t * | minutesPtr, | ||
uint16_t * | secondsPtr, | ||
uint16_t * | millisecondsPtr | ||
) |
Gets the position sample's time.
[in] | positionSampleRef | Position sample reference. |
[out] | hoursPtr | UTC hours of the day; range is 0 to 23. |
[out] | minutesPtr | UTC minutes of the hour; range is 0 to 59. |
[out] | secondsPtr | UTC seconds of the minute; range is 0 to 59. |
[out] | millisecondsPtr | UTC milliseconds of the second; range is 0 to 999. |
le_result_t taf_locPos_sample_GetHorizontalSpeed | ( | taf_locPos_SampleRef_t | positionSampleRef, |
uint32_t * | hSpeedPtr, | ||
uint32_t * | hSpeedAccuracyPtr | ||
) |
Gets the position sample's horizontal speed.
[in] | positionSampleRef | Position sample reference. |
[out] | hSpeedPtr | The horizontal speed in m/sec. |
[out] | hSpeedAccuracyPtr | The horizontal accuracy in m/sec. |
le_result_t taf_locPos_sample_GetDirection | ( | taf_locPos_SampleRef_t | positionSampleRef, |
uint32_t * | directionPtr, | ||
uint32_t * | directionAccuracyPtr | ||
) |
Get the position sample's direction
[in] | positionSampleRef | Position sample reference. |
[out] | directionPtr | Direction indication in degrees. |
[out] | directionAccuracyPtr | Direction's accuracy estimation in degrees. |
le_result_t taf_locPos_sample_GetVerticalSpeed | ( | taf_locPos_SampleRef_t | positionSampleRef, |
int32_t * | vspeedPtr, | ||
int32_t * | vspeedAccuracyPtr | ||
) |
Gets the position sample's vertical speed.
[in] | positionSampleRef | Position sample reference |
[out] | vspeedPtr | The vertical speed in m/sec. |
[out] | vspeedAccuracyPtr | The vertical speed's accuracy in m/sec. |
le_result_t taf_locPos_SetDistanceResolution | ( | taf_locPos_Resolution_t | resolution | ) |
Sets the resolution for the positioning distance values.
[in] | resolution | Resolution. |
le_result_t taf_locPos_sample_GetFixState | ( | taf_locPos_SampleRef_t | positionSampleRef, |
taf_locGnss_FixState_t * | statePtr | ||
) |
Gets the position sample's fix state.
[in] | positionSampleRef | Position sample reference. |
[out] | statePtr | Position fix state. |
le_result_t taf_locPos_sample_GetDate | ( | taf_locPos_SampleRef_t | positionSampleRef, |
uint16_t * | yearPtr, | ||
uint16_t * | monthPtr, | ||
uint16_t * | dayPtr | ||
) |
Gets the position sample date.
[in] | positionSampleRef | Position sample reference. |
[out] | yearPtr | UTC year |
[out] | monthPtr | UTC month of the year; range is 1 to 12. |
[out] | dayPtr | UTC day of the month; range is 1 to 31. |
|
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.