Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
Go to the source code of this file.
le_msg_ServiceRef_t taf_dcs_GetServiceRef | ( | void | ) |
Get the server service reference
le_msg_SessionRef_t taf_dcs_GetClientSessionRef | ( | void | ) |
Get the client session reference for the current message
void taf_dcs_AdvertiseService | ( | void | ) |
Initialize the server and advertise the service.
le_result_t taf_dcs_StartSession | ( | taf_dcs_ProfileRef_t | profileRef | ) |
Reference to the cellular profile context. Reference to the data call session context. The squash gateway addresses used by net APIs The squash DNS addresses used by net APIs. The supported data bearer technology. The supported data cellular call connection event. The data profile PDP type. The roaming type. The data profile authentication type. The APN type The data profile technology type. Additional state information. IP: The IP Type of this event, e.g., which interface (IPv4/IPv6) is supported on a CONNECTED event. The roaming status indication. The handler for asynchronous session start or stop result response. The data call session handler. Reference type used by Add/Remove functions for EVENT 'taf_dcs_SessionState' Handler for roaming status. Reference type used by Add/Remove functions for EVENT 'taf_dcs_RoamingStatus' The data profile structure. The handler of the requesting data profile list. Starts a synchronous data cellular session for the given profile reference.
Starts a synchronous data cellular session for the given profile reference.
[in] | profileRef | The profile reference. |
void taf_dcs_StartSessionAsync | ( | taf_dcs_ProfileRef_t | profileRef, |
taf_dcs_AsyncSessionHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Starts (asynchronously) a cellular data session for the given profile reference.
[in] | profileRef | The profile reference. |
[in] | handlerPtr | The handler. |
[in] | contextPtr |
le_result_t taf_dcs_StopSession | ( | taf_dcs_ProfileRef_t | profileRef | ) |
Stops (synchronously) a cellular data session for the given profile reference.
[in] | profileRef | The profile reference. |
void taf_dcs_StopSessionAsync | ( | taf_dcs_ProfileRef_t | profileRef, |
taf_dcs_AsyncSessionHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Stops (asynchronously) a cellular data session for the given profile reference.
[in] | profileRef | The profile reference. |
[in] | handlerPtr | The handler. |
[in] | contextPtr |
le_result_t taf_dcs_GetInterfaceName | ( | taf_dcs_ProfileRef_t | profileRef, |
char * | ifName, | ||
size_t | ifNameSize | ||
) |
Gets a connected data call interface name.
[in] | profileRef | The profile reference. |
[out] | ifName | The interface name. |
[in] | ifNameSize |
taf_dcs_SessionStateHandlerRef_t taf_dcs_AddSessionStateHandler | ( | taf_dcs_ProfileRef_t | profileRef, |
taf_dcs_SessionStateHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_dcs_SessionState'
The data call session event.
[in] | profileRef | The profile reference. |
[in] | handlerPtr | The event handler reference. |
[in] | contextPtr |
void taf_dcs_RemoveSessionStateHandler | ( | taf_dcs_SessionStateHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_dcs_SessionState'
[in] | handlerRef |
taf_dcs_RoamingStatusHandlerRef_t taf_dcs_AddRoamingStatusHandler | ( | taf_dcs_RoamingStatusHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_dcs_RoamingStatus'
Event to report roaming status.
[in] | handlerPtr | Handler for roaming status. |
[in] | contextPtr |
void taf_dcs_RemoveRoamingStatusHandler | ( | taf_dcs_RoamingStatusHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_dcs_RoamingStatus'
[in] | handlerRef |
le_result_t taf_dcs_GetRoamingStatus | ( | uint8_t | phoneId, |
bool * | isRoamingPtr, | ||
taf_dcs_RoamingType_t * | typePtr | ||
) |
Gets the roaming status.
[in] | phoneId | The phone ID. |
[out] | isRoamingPtr | True means that roaming is on; False means that |
[out] | typePtr | The roaming type. Valid only if roaming is on. |
le_result_t taf_dcs_GetIPv4Address | ( | taf_dcs_ProfileRef_t | profileRef, |
char * | ipAddr, | ||
size_t | ipAddrSize | ||
) |
Gets the connected data session IPv4 address.
[in] | profileRef | The profile reference. |
[out] | ipAddr | The IPv4 address. |
[in] | ipAddrSize |
le_result_t taf_dcs_GetIPv4GatewayAddress | ( | taf_dcs_ProfileRef_t | profileRef, |
char * | gatewayAddr, | ||
size_t | gatewayAddrSize | ||
) |
Gets the connected data session IPv4 gateway address.
[in] | profileRef | The profile reference. |
[out] | gatewayAddr | The IPv4 gateway address. |
[in] | gatewayAddrSize |
le_result_t taf_dcs_GetIPv4DNSAddresses | ( | taf_dcs_ProfileRef_t | profileRef, |
char * | dns1AddrStr, | ||
size_t | dns1AddrStrSize, | ||
char * | dns2AddrStr, | ||
size_t | dns2AddrStrSize | ||
) |
Gets the connected data session primary and secondary DNS IPv4 addresses.
[in] | profileRef | The profile reference. |
[out] | dns1AddrStr | The IPv4 primary DNS address. |
[in] | dns1AddrStrSize | |
[out] | dns2AddrStr | The IPv4 secondary DNS address. |
[in] | dns2AddrStrSize |
le_result_t taf_dcs_GetIPv6Address | ( | taf_dcs_ProfileRef_t | profileRef, |
char * | ipAddr, | ||
size_t | ipAddrSize | ||
) |
Gets the connected data session IPv6 address.
[in] | profileRef | The profile reference. |
[out] | ipAddr | The IPv6 address. |
[in] | ipAddrSize |
le_result_t taf_dcs_GetIPv6GatewayAddress | ( | taf_dcs_ProfileRef_t | profileRef, |
char * | gatewayAddr, | ||
size_t | gatewayAddrSize | ||
) |
Gets the connected data session IPv6 gateway address.
[in] | profileRef | The profile reference. |
[out] | gatewayAddr | The IPv6 gateway address. |
[in] | gatewayAddrSize |
le_result_t taf_dcs_GetIPv6DNSAddresses | ( | taf_dcs_ProfileRef_t | profileRef, |
char * | dns1AddrStr, | ||
size_t | dns1AddrStrSize, | ||
char * | dns2AddrStr, | ||
size_t | dns2AddrStrSize | ||
) |
Gets the connected data session primary and secondary DNS IPv6 addresses.
[in] | profileRef | The profile reference. |
[out] | dns1AddrStr | The IPv6 primary DNS address. |
[in] | dns1AddrStrSize | |
[out] | dns2AddrStr | The IPv6 secondary DNS address. |
[in] | dns2AddrStrSize |
le_result_t taf_dcs_GetSessionState | ( | taf_dcs_ProfileRef_t | profileRef, |
taf_dcs_ConState_t * | connectionStatePtr | ||
) |
Gets the data session's current state.
[in] | profileRef | The profile reference. |
[out] | connectionStatePtr | The connection state. |
bool taf_dcs_IsIPv4 | ( | taf_dcs_ProfileRef_t | profileRef | ) |
Checks if the data session is IPv4.
[in] | profileRef | The profile reference. |
bool taf_dcs_IsIPv6 | ( | taf_dcs_ProfileRef_t | profileRef | ) |
Checks if the data session is IPv6.
[in] | profileRef | The profile reference. |
le_result_t taf_dcs_GetDataBearerTechnology | ( | taf_dcs_ProfileRef_t | profileRef, |
taf_dcs_DataBearerTechnology_t * | dlDataBearerTechPtrPtr, | ||
taf_dcs_DataBearerTechnology_t * | ulDataBearerTechPtrPtr | ||
) |
Gets the connected data session data bearer technology.
[in] | profileRef | The profile reference. |
[out] | dlDataBearerTechPtrPtr | The downlink data bearer technology. |
[out] | ulDataBearerTechPtrPtr | The uplink data bearer technology. |
le_result_t taf_dcs_GetProfileList | ( | taf_dcs_ProfileInfo_t * | profileListPtr, |
size_t * | profileListSizePtr | ||
) |
Gets the data profile list.
[out] | profileListPtr | The profile list information. |
[in,out] | profileListSizePtr |
le_result_t taf_dcs_GetProfileListEx | ( | uint8_t | phoneId, |
taf_dcs_ProfileInfo_t * | profileListPtr, | ||
size_t * | profileListSizePtr | ||
) |
Gets the data profile list with the specified phone ID.
[in] | phoneId | The phone ID. |
[out] | profileListPtr | The profile list information. |
[in,out] | profileListSizePtr |
uint32_t taf_dcs_GetDefaultProfileIndex | ( | void | ) |
Gets the default profile index.
le_result_t taf_dcs_GetDefaultPhoneIdAndProfileId | ( | uint8_t * | phoneIdPtr, |
uint32_t * | profileIdPtr | ||
) |
Gets the default phone ID and profile index.
[out] | phoneIdPtr | The phone ID. |
[out] | profileIdPtr | The profile index. |
le_result_t taf_dcs_SetDefaultProfileIndex | ( | uint32_t | profileId | ) |
Sets the default profile index corresponding to the specified profile index.
[in] | profileId | The profile index. |
le_result_t taf_dcs_SetDefaultProfileIndexEx | ( | uint8_t | phoneId, |
uint32_t | profileId | ||
) |
Sets the default profile corresponding to the specified phone ID and profile index.
[in] | phoneId | The phone ID. |
[in] | profileId | The profile index. |
taf_dcs_ProfileRef_t taf_dcs_GetProfile | ( | uint32_t | profileId | ) |
Gets the profile reference for the given profile index.
[in] | profileId | The profile index. |
taf_dcs_ProfileRef_t taf_dcs_GetProfileEx | ( | uint8_t | phoneId, |
uint32_t | profileId | ||
) |
Gets the profile reference for the given phone ID and profile index.
[in] | phoneId | The phone ID. |
[in] | profileId | The profile index. |
uint32_t taf_dcs_GetProfileIndex | ( | taf_dcs_ProfileRef_t | profileRef | ) |
Gets the profile index for the given profile reference.
[in] | profileRef | The profile reference. |
le_result_t taf_dcs_GetPhoneId | ( | taf_dcs_ProfileRef_t | profileRef, |
uint8_t * | phoneIdPtr | ||
) |
Gets the phone ID for the given profile reference.
[in] | profileRef | The profile reference. |
[out] | phoneIdPtr | The phone ID. |
le_result_t taf_dcs_SetAPN | ( | taf_dcs_ProfileRef_t | profileRef, |
const char *LE_NONNULL | apnName | ||
) |
Sets the data profile APN name.
[in] | profileRef | The profile reference. |
[in] | apnName | The APN name. |
le_result_t taf_dcs_GetAPN | ( | taf_dcs_ProfileRef_t | profileRef, |
char * | apnName, | ||
size_t | apnNameSize | ||
) |
Gets the data profile APN name.
[in] | profileRef | The profile reference. |
[out] | apnName | The APN name. |
[in] | apnNameSize |
le_result_t taf_dcs_GetApnTypes | ( | taf_dcs_ProfileRef_t | profileRef, |
taf_dcs_ApnType_t * | apnTypePtr | ||
) |
Gets the data profile APN types.
[in] | profileRef | The profile reference. |
[out] | apnTypePtr | The APN type. |
le_result_t taf_dcs_SetPDP | ( | taf_dcs_ProfileRef_t | profileRef, |
taf_dcs_Pdp_t | pdp | ||
) |
Sets the data profile PDP type.
[in] | profileRef | The profile reference. |
[in] | pdp | The PDP type. |
taf_dcs_Pdp_t taf_dcs_GetPDP | ( | taf_dcs_ProfileRef_t | profileRef | ) |
Gets the data profile PDP type.
[in] | profileRef | The profile reference. |
le_result_t taf_dcs_SetAuthentication | ( | taf_dcs_ProfileRef_t | profileRef, |
taf_dcs_Auth_t | auth, | ||
const char *LE_NONNULL | userName, | ||
const char *LE_NONNULL | password | ||
) |
Set the data profile authentication type and username/password.
[in] | profileRef | The profile reference. |
[in] | auth | The authentication type. |
[in] | userName | The username. |
[in] | password | The password. |
le_result_t taf_dcs_GetAuthentication | ( | taf_dcs_ProfileRef_t | profileRef, |
taf_dcs_Auth_t * | authPtr, | ||
char * | userName, | ||
size_t | userNameSize, | ||
char * | password, | ||
size_t | passwordSize | ||
) |
Gets the data profile authentication type and username/password.
[in] | profileRef | The profile reference. |
[out] | authPtr | The authentication type. |
[out] | userName | The username. |
[in] | userNameSize | |
[out] | password | The password. |
[in] | passwordSize |
le_result_t taf_dcs_GetProfileIdByInterfaceName | ( | const char *LE_NONNULL | ifName, |
uint32_t * | profileIdPtr | ||
) |
Gets the data profile index by the interface name.
[in] | ifName | The interface name. |
[out] | profileIdPtr | The profile index. |
le_result_t taf_dcs_GetPhoneIdByInterfaceName | ( | const char *LE_NONNULL | ifName, |
uint8_t * | phoneIdPtr | ||
) |
Gets the phone ID by the interface name.
[in] | ifName | The interface name. |
[out] | phoneIdPtr | The phone ID. |