Snapdragon® Telematics Application Framework (TelAF) Interface Specification
taf_dcs_server.h File Reference
#include "legato.h"
#include "taf_types_server.h"
#include "taf_dcs_common.h"

Go to the source code of this file.

Functions

le_msg_ServiceRef_t taf_dcs_GetServiceRef (void)
 
le_msg_SessionRef_t taf_dcs_GetClientSessionRef (void)
 
void taf_dcs_AdvertiseService (void)
 
le_result_t taf_dcs_StartSession (taf_dcs_ProfileRef_t profileRef)
 
void taf_dcs_StartSessionAsync (taf_dcs_ProfileRef_t profileRef, taf_dcs_AsyncSessionHandlerFunc_t handlerPtr, void *contextPtr)
 
le_result_t taf_dcs_StopSession (taf_dcs_ProfileRef_t profileRef)
 
void taf_dcs_StopSessionAsync (taf_dcs_ProfileRef_t profileRef, taf_dcs_AsyncSessionHandlerFunc_t handlerPtr, void *contextPtr)
 
le_result_t taf_dcs_GetInterfaceName (taf_dcs_ProfileRef_t profileRef, char *ifName, size_t ifNameSize)
 
taf_dcs_SessionStateHandlerRef_t taf_dcs_AddSessionStateHandler (taf_dcs_ProfileRef_t profileRef, taf_dcs_SessionStateHandlerFunc_t handlerPtr, void *contextPtr)
 
void taf_dcs_RemoveSessionStateHandler (taf_dcs_SessionStateHandlerRef_t handlerRef)
 
taf_dcs_RoamingStatusHandlerRef_t taf_dcs_AddRoamingStatusHandler (taf_dcs_RoamingStatusHandlerFunc_t handlerPtr, void *contextPtr)
 
void taf_dcs_RemoveRoamingStatusHandler (taf_dcs_RoamingStatusHandlerRef_t handlerRef)
 
le_result_t taf_dcs_GetRoamingStatus (uint8_t phoneId, bool *isRoamingPtr, taf_dcs_RoamingType_t *typePtr)
 
le_result_t taf_dcs_GetIPv4Address (taf_dcs_ProfileRef_t profileRef, char *ipAddr, size_t ipAddrSize)
 
le_result_t taf_dcs_GetIPv4GatewayAddress (taf_dcs_ProfileRef_t profileRef, char *gatewayAddr, size_t gatewayAddrSize)
 
le_result_t taf_dcs_GetIPv4DNSAddresses (taf_dcs_ProfileRef_t profileRef, char *dns1AddrStr, size_t dns1AddrStrSize, char *dns2AddrStr, size_t dns2AddrStrSize)
 
le_result_t taf_dcs_GetIPv6Address (taf_dcs_ProfileRef_t profileRef, char *ipAddr, size_t ipAddrSize)
 
le_result_t taf_dcs_GetIPv6GatewayAddress (taf_dcs_ProfileRef_t profileRef, char *gatewayAddr, size_t gatewayAddrSize)
 
le_result_t taf_dcs_GetIPv6DNSAddresses (taf_dcs_ProfileRef_t profileRef, char *dns1AddrStr, size_t dns1AddrStrSize, char *dns2AddrStr, size_t dns2AddrStrSize)
 
le_result_t taf_dcs_GetSessionState (taf_dcs_ProfileRef_t profileRef, taf_dcs_ConState_t *connectionStatePtr)
 
bool taf_dcs_IsIPv4 (taf_dcs_ProfileRef_t profileRef)
 
bool taf_dcs_IsIPv6 (taf_dcs_ProfileRef_t profileRef)
 
le_result_t taf_dcs_GetDataBearerTechnology (taf_dcs_ProfileRef_t profileRef, taf_dcs_DataBearerTechnology_t *dlDataBearerTechPtrPtr, taf_dcs_DataBearerTechnology_t *ulDataBearerTechPtrPtr)
 
le_result_t taf_dcs_GetProfileList (taf_dcs_ProfileInfo_t *profileListPtr, size_t *profileListSizePtr)
 
le_result_t taf_dcs_GetProfileListEx (uint8_t phoneId, taf_dcs_ProfileInfo_t *profileListPtr, size_t *profileListSizePtr)
 
uint32_t taf_dcs_GetDefaultProfileIndex (void)
 
le_result_t taf_dcs_GetDefaultPhoneIdAndProfileId (uint8_t *phoneIdPtr, uint32_t *profileIdPtr)
 
le_result_t taf_dcs_SetDefaultProfileIndex (uint32_t profileId)
 
le_result_t taf_dcs_SetDefaultProfileIndexEx (uint8_t phoneId, uint32_t profileId)
 
taf_dcs_ProfileRef_t taf_dcs_GetProfile (uint32_t profileId)
 
taf_dcs_ProfileRef_t taf_dcs_GetProfileEx (uint8_t phoneId, uint32_t profileId)
 
uint32_t taf_dcs_GetProfileIndex (taf_dcs_ProfileRef_t profileRef)
 
le_result_t taf_dcs_GetPhoneId (taf_dcs_ProfileRef_t profileRef, uint8_t *phoneIdPtr)
 
le_result_t taf_dcs_SetAPN (taf_dcs_ProfileRef_t profileRef, const char *LE_NONNULL apnName)
 
le_result_t taf_dcs_GetAPN (taf_dcs_ProfileRef_t profileRef, char *apnName, size_t apnNameSize)
 
le_result_t taf_dcs_GetApnTypes (taf_dcs_ProfileRef_t profileRef, taf_dcs_ApnType_t *apnTypePtr)
 
le_result_t taf_dcs_SetPDP (taf_dcs_ProfileRef_t profileRef, taf_dcs_Pdp_t pdp)
 
taf_dcs_Pdp_t taf_dcs_GetPDP (taf_dcs_ProfileRef_t profileRef)
 
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)
 
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)
 
le_result_t taf_dcs_GetProfileIdByInterfaceName (const char *LE_NONNULL ifName, uint32_t *profileIdPtr)
 
le_result_t taf_dcs_GetPhoneIdByInterfaceName (const char *LE_NONNULL ifName, uint8_t *phoneIdPtr)
 

Function Documentation

◆ taf_dcs_GetServiceRef()

le_msg_ServiceRef_t taf_dcs_GetServiceRef ( void  )

Get the server service reference

◆ taf_dcs_GetClientSessionRef()

le_msg_SessionRef_t taf_dcs_GetClientSessionRef ( void  )

Get the client session reference for the current message

◆ taf_dcs_AdvertiseService()

void taf_dcs_AdvertiseService ( void  )

Initialize the server and advertise the service.

◆ taf_dcs_StartSession()

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.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Parameter is invalid or couldn't create the data call.
  • LE_OUT_OF_RANGE – PDP type is unknown.
  • LE_DUPLICATE – If the data session is already connected for the given profile.
  • LE_IN_PROGRESS – The profile is in use and a data call is in progress.
  • LE_TIMEOUT – Timed out when attempting to make the data call.
  • LE_FAULT – Failed.

Starts a synchronous data cellular session for the given profile reference.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Parameter is invalid or couldn't create the data call.
  • LE_OUT_OF_RANGE – PDP type is unknown.
  • LE_DUPLICATE – If the data session is already connected for the given profile.
  • LE_IN_PROGRESS – The profile is in use and a data call is in progress.
  • LE_TIMEOUT – Timed out when attempting to make the data call.
  • LE_FAULT – Failed.
Parameters
[in]profileRefThe profile reference.

◆ taf_dcs_StartSessionAsync()

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.

Returns
None.
Parameters
[in]profileRefThe profile reference.
[in]handlerPtrThe handler.
[in]contextPtr

◆ taf_dcs_StopSession()

le_result_t taf_dcs_StopSession ( taf_dcs_ProfileRef_t  profileRef)

Stops (synchronously) a cellular data session for the given profile reference.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Can't find a data call.
  • LE_OUT_OF_RANGE – PdpType type is unknown.
  • LE_BAD_PARAMETER – Call context is NULL.
  • LE_TIMEOUT – Timeout to stop a data call.
  • LE_IN_PROGRESS – The profile is in use and a data call is in progress.
  • LE_FAULT – Failed.
Parameters
[in]profileRefThe profile reference.

◆ taf_dcs_StopSessionAsync()

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.

Returns
None.
Parameters
[in]profileRefThe profile reference.
[in]handlerPtrThe handler.
[in]contextPtr

◆ taf_dcs_GetInterfaceName()

le_result_t taf_dcs_GetInterfaceName ( taf_dcs_ProfileRef_t  profileRef,
char *  ifName,
size_t  ifNameSize 
)

Gets a connected data call interface name.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_NOT_POSSIBLE – Invalid status.
  • LE_NOT_FOUND – Cannot find the interface name.
Parameters
[in]profileRefThe profile reference.
[out]ifNameThe interface name.
[in]ifNameSize

◆ taf_dcs_AddSessionStateHandler()

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.

Parameters
[in]profileRefThe profile reference.
[in]handlerPtrThe event handler reference.
[in]contextPtr

◆ taf_dcs_RemoveSessionStateHandler()

void taf_dcs_RemoveSessionStateHandler ( taf_dcs_SessionStateHandlerRef_t  handlerRef)

Remove handler function for EVENT 'taf_dcs_SessionState'

Parameters
[in]handlerRef

◆ taf_dcs_AddRoamingStatusHandler()

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.

Parameters
[in]handlerPtrHandler for roaming status.
[in]contextPtr

◆ taf_dcs_RemoveRoamingStatusHandler()

void taf_dcs_RemoveRoamingStatusHandler ( taf_dcs_RoamingStatusHandlerRef_t  handlerRef)

Remove handler function for EVENT 'taf_dcs_RoamingStatus'

Parameters
[in]handlerRef

◆ taf_dcs_GetRoamingStatus()

le_result_t taf_dcs_GetRoamingStatus ( uint8_t  phoneId,
bool *  isRoamingPtr,
taf_dcs_RoamingType_t typePtr 
)

Gets the roaming status.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameters.
  • LE_TIMEOUT – Response timed out.
  • LE_FAULT – Failed.
Parameters
[in]phoneIdThe phone ID.
[out]isRoamingPtrTrue means that roaming is on; False means that
[out]typePtrThe roaming type. Valid only if roaming is on.

◆ taf_dcs_GetIPv4Address()

le_result_t taf_dcs_GetIPv4Address ( taf_dcs_ProfileRef_t  profileRef,
char *  ipAddr,
size_t  ipAddrSize 
)

Gets the connected data session IPv4 address.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Failed.
Parameters
[in]profileRefThe profile reference.
[out]ipAddrThe IPv4 address.
[in]ipAddrSize

◆ taf_dcs_GetIPv4GatewayAddress()

le_result_t taf_dcs_GetIPv4GatewayAddress ( taf_dcs_ProfileRef_t  profileRef,
char *  gatewayAddr,
size_t  gatewayAddrSize 
)

Gets the connected data session IPv4 gateway address.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Failed.
Parameters
[in]profileRefThe profile reference.
[out]gatewayAddrThe IPv4 gateway address.
[in]gatewayAddrSize

◆ taf_dcs_GetIPv4DNSAddresses()

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.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Failed.
Parameters
[in]profileRefThe profile reference.
[out]dns1AddrStrThe IPv4 primary DNS address.
[in]dns1AddrStrSize
[out]dns2AddrStrThe IPv4 secondary DNS address.
[in]dns2AddrStrSize

◆ taf_dcs_GetIPv6Address()

le_result_t taf_dcs_GetIPv6Address ( taf_dcs_ProfileRef_t  profileRef,
char *  ipAddr,
size_t  ipAddrSize 
)

Gets the connected data session IPv6 address.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Failed.
Parameters
[in]profileRefThe profile reference.
[out]ipAddrThe IPv6 address.
[in]ipAddrSize

◆ taf_dcs_GetIPv6GatewayAddress()

le_result_t taf_dcs_GetIPv6GatewayAddress ( taf_dcs_ProfileRef_t  profileRef,
char *  gatewayAddr,
size_t  gatewayAddrSize 
)

Gets the connected data session IPv6 gateway address.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Failed.
Parameters
[in]profileRefThe profile reference.
[out]gatewayAddrThe IPv6 gateway address.
[in]gatewayAddrSize

◆ taf_dcs_GetIPv6DNSAddresses()

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.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Failed.
Parameters
[in]profileRefThe profile reference.
[out]dns1AddrStrThe IPv6 primary DNS address.
[in]dns1AddrStrSize
[out]dns2AddrStrThe IPv6 secondary DNS address.
[in]dns2AddrStrSize

◆ taf_dcs_GetSessionState()

le_result_t taf_dcs_GetSessionState ( taf_dcs_ProfileRef_t  profileRef,
taf_dcs_ConState_t connectionStatePtr 
)

Gets the data session's current state.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Failed.
Parameters
[in]profileRefThe profile reference.
[out]connectionStatePtrThe connection state.

◆ taf_dcs_IsIPv4()

bool taf_dcs_IsIPv4 ( taf_dcs_ProfileRef_t  profileRef)

Checks if the data session is IPv4.

Returns
  • True – IPv4.
  • False – Not IPv4 or the profile reference is invalid.
Parameters
[in]profileRefThe profile reference.

◆ taf_dcs_IsIPv6()

bool taf_dcs_IsIPv6 ( taf_dcs_ProfileRef_t  profileRef)

Checks if the data session is IPv6.

Returns
  • True – IPv6.
  • False – Not IPv6 or the profile reference is invalid.
Parameters
[in]profileRefThe profile reference.

◆ taf_dcs_GetDataBearerTechnology()

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.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Failed.
Parameters
[in]profileRefThe profile reference.
[out]dlDataBearerTechPtrPtrThe downlink data bearer technology.
[out]ulDataBearerTechPtrPtrThe uplink data bearer technology.

◆ taf_dcs_GetProfileList()

le_result_t taf_dcs_GetProfileList ( taf_dcs_ProfileInfo_t profileListPtr,
size_t *  profileListSizePtr 
)

Gets the data profile list.

Note
For Dual Sim-Single Active (DSSA) mode and Dual Sim-Dual Active (DSDA) mode, this API gets the data profile list with phone ID 1.
Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[out]profileListPtrThe profile list information.
[in,out]profileListSizePtr

◆ taf_dcs_GetProfileListEx()

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.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]phoneIdThe phone ID.
[out]profileListPtrThe profile list information.
[in,out]profileListSizePtr

◆ taf_dcs_GetDefaultProfileIndex()

uint32_t taf_dcs_GetDefaultProfileIndex ( void  )

Gets the default profile index.

Returns
  • uint32 – The profile index.

◆ taf_dcs_GetDefaultPhoneIdAndProfileId()

le_result_t taf_dcs_GetDefaultPhoneIdAndProfileId ( uint8_t *  phoneIdPtr,
uint32_t *  profileIdPtr 
)

Gets the default phone ID and profile index.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[out]phoneIdPtrThe phone ID.
[out]profileIdPtrThe profile index.

◆ taf_dcs_SetDefaultProfileIndex()

le_result_t taf_dcs_SetDefaultProfileIndex ( uint32_t  profileId)

Sets the default profile index corresponding to the specified profile index.

Note
For Dual Sim-Single Active (DSSA) mode and Dual Sim-Dual Active (DSDA) mode, this API sets the data profile with default phone ID 1.
Returns
  • LE_OK – Succeeded.
  • LE_FAULT – Failed.
Parameters
[in]profileIdThe profile index.

◆ taf_dcs_SetDefaultProfileIndexEx()

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.

Returns
  • LE_OK – Succeeded.
  • LE_FAULT – Failed.
Parameters
[in]phoneIdThe phone ID.
[in]profileIdThe profile index.

◆ taf_dcs_GetProfile()

taf_dcs_ProfileRef_t taf_dcs_GetProfile ( uint32_t  profileId)

Gets the profile reference for the given profile index.

Note
For Dual Sim-Single Active (DSSA) mode and Dual Sim-Dual Active (DSDA) mode, this API gets the profile reference with phone ID 1.
Returns
  • NULL – Error.
  • Others – The profile reference.
Parameters
[in]profileIdThe profile index.

◆ taf_dcs_GetProfileEx()

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.

Returns
  • NULL – Error.
  • Others – The profile reference.
Parameters
[in]phoneIdThe phone ID.
[in]profileIdThe profile index.

◆ taf_dcs_GetProfileIndex()

uint32_t taf_dcs_GetProfileIndex ( taf_dcs_ProfileRef_t  profileRef)

Gets the profile index for the given profile reference.

Returns
  • uint32 – The profile index. 0 – Failed
Parameters
[in]profileRefThe profile reference.

◆ taf_dcs_GetPhoneId()

le_result_t taf_dcs_GetPhoneId ( taf_dcs_ProfileRef_t  profileRef,
uint8_t *  phoneIdPtr 
)

Gets the phone ID for the given profile reference.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_NOT_FOUND – Profile reference was not found.
  • LE_FAULT – Failed.
Parameters
[in]profileRefThe profile reference.
[out]phoneIdPtrThe phone ID.

◆ taf_dcs_SetAPN()

le_result_t taf_dcs_SetAPN ( taf_dcs_ProfileRef_t  profileRef,
const char *LE_NONNULL  apnName 
)

Sets the data profile APN name.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Profile reference was not found.
  • LE_FAULT – Failed.
Parameters
[in]profileRefThe profile reference.
[in]apnNameThe APN name.

◆ taf_dcs_GetAPN()

le_result_t taf_dcs_GetAPN ( taf_dcs_ProfileRef_t  profileRef,
char *  apnName,
size_t  apnNameSize 
)

Gets the data profile APN name.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Failed.
  • LE_OVERFLOW – Apn size is smaller than APN_NAME_MAX_BYTES.
Parameters
[in]profileRefThe profile reference.
[out]apnNameThe APN name.
[in]apnNameSize

◆ taf_dcs_GetApnTypes()

le_result_t taf_dcs_GetApnTypes ( taf_dcs_ProfileRef_t  profileRef,
taf_dcs_ApnType_t apnTypePtr 
)

Gets the data profile APN types.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Failed.
Parameters
[in]profileRefThe profile reference.
[out]apnTypePtrThe APN type.

◆ taf_dcs_SetPDP()

le_result_t taf_dcs_SetPDP ( taf_dcs_ProfileRef_t  profileRef,
taf_dcs_Pdp_t  pdp 
)

Sets the data profile PDP type.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Profile reference was not found.
  • LE_FAULT – Failed.
Parameters
[in]profileRefThe profile reference.
[in]pdpThe PDP type.

◆ taf_dcs_GetPDP()

taf_dcs_Pdp_t taf_dcs_GetPDP ( taf_dcs_ProfileRef_t  profileRef)

Gets the data profile PDP type.

Returns
  • AF_DCS_PDP_UNKNOWN – Unknown.
  • AF_DCS_PDP_IPV4 – IPV4.
  • AF_DCS_PDP_IPV6 – IPV6.
  • AF_DCS_PDP_IPV4V6 – IPV4 and IPV6.
Parameters
[in]profileRefThe profile reference.

◆ taf_dcs_SetAuthentication()

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.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Could not retrieve the profile information.
  • LE_FAULT – Failed.
Parameters
[in]profileRefThe profile reference.
[in]authThe authentication type.
[in]userNameThe username.
[in]passwordThe password.

◆ taf_dcs_GetAuthentication()

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.

Returns
  • LE_OK – Succeeded.
  • LE_OUT_OF_RANGE – The size of username or password is invalid.
  • LE_NOT_FOUND – Failed.
Parameters
[in]profileRefThe profile reference.
[out]authPtrThe authentication type.
[out]userNameThe username.
[in]userNameSize
[out]passwordThe password.
[in]passwordSize

◆ taf_dcs_GetProfileIdByInterfaceName()

le_result_t taf_dcs_GetProfileIdByInterfaceName ( const char *LE_NONNULL  ifName,
uint32_t *  profileIdPtr 
)

Gets the data profile index by the interface name.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_NOT_FOUND – Failed.
Parameters
[in]ifNameThe interface name.
[out]profileIdPtrThe profile index.

◆ taf_dcs_GetPhoneIdByInterfaceName()

le_result_t taf_dcs_GetPhoneIdByInterfaceName ( const char *LE_NONNULL  ifName,
uint8_t *  phoneIdPtr 
)

Gets the phone ID by the interface name.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_NOT_FOUND – Failed.
Parameters
[in]ifNameThe interface name.
[out]phoneIdPtrThe phone ID.