Snapdragon® Telematics Application Framework (TelAF) Interface Specification
Data Structures | Macros | Typedefs | Enumerations | Functions
taf_dcs_common.h File Reference
#include "legato.h"
#include "taf_types_common.h"

Go to the source code of this file.

Data Structures

struct  taf_dcs_DefaultGatewayAddresses_t
 
struct  taf_dcs_DnsServerAddresses_t
 
struct  taf_dcs_StateInfo_t
 
struct  taf_dcs_RoamingStatusInd_t
 
struct  taf_dcs_ProfileInfo_t
 

Macros

#define IFGEN_TAF_DCS_PROTOCOL_ID   "68cf9aa5086404da8037281238787893"
 
#define IFGEN_TAF_DCS_MSG_SIZE   2320
 
#define TAF_DCS_NAME_MAX_LEN   64
 
#define TAF_DCS_NAME_MAX_BYTES   65
 
#define TAF_DCS_MAX_CALL_OBJ   32
 
#define TAF_DCS_MAX_SESSION_REF   32
 
#define TAF_DCS_APN_NAME_MAX_LEN   64
 
#define TAF_DCS_APN_NAME_MAX_BYTES   65
 
#define TAF_DCS_USER_NAME_MAX_LEN   64
 
#define TAF_DCS_PASSWORD_NAME_MAX_LEN   64
 
#define TAF_DCS_USER_NAME_MAX_BYTES   65
 
#define TAF_DCS_PASSWORD_NAME_MAX_BYTES   65
 
#define TAF_DCS_IPV4_ADDR_MAX_LEN   16
 
#define TAF_DCS_IPV6_ADDR_MAX_LEN   46
 
#define TAF_DCS_DEFAULT_PROFILE   1
 
#define TAF_DCS_PROFILE_LIST_MAX_ENTRY   32
 
#define TAF_DCS_MAX_ASYNC_HANDLER_MAPPING   20
 
#define TAF_DCS_AUTH_NONE   0x1
 
#define TAF_DCS_AUTH_PAP   0x2
 
#define TAF_DCS_AUTH_CHAP   0x4
 
#define TAF_DCS_APN_TYPE_DEFAULT   0x1
 
#define TAF_DCS_APN_TYPE_IMS   0x2
 
#define TAF_DCS_APN_TYPE_MMS   0x4
 
#define TAF_DCS_APN_TYPE_DUN   0x8
 
#define TAF_DCS_APN_TYPE_SUPL   0x10
 
#define TAF_DCS_APN_TYPE_HIPRI   0x20
 
#define TAF_DCS_APN_TYPE_FOTA   0x40
 
#define TAF_DCS_APN_TYPE_CBS   0x80
 
#define TAF_DCS_APN_TYPE_IA   0x100
 
#define TAF_DCS_APN_TYPE_EMERGENCY   0x200
 
#define TAF_DCS_APN_TYPE_UT   0x400
 
#define TAF_DCS_APN_TYPE_MCX   0x800
 

Typedefs

typedef struct taf_dcs_Profile * taf_dcs_ProfileRef_t
 
typedef struct taf_dcs_Call * taf_dcs_CallRef_t
 
typedef uint32_t taf_dcs_Auth_t
 
typedef uint32_t taf_dcs_ApnType_t
 
typedef struct taf_dcs_SessionStateHandler * taf_dcs_SessionStateHandlerRef_t
 
typedef struct taf_dcs_RoamingStatusHandler * taf_dcs_RoamingStatusHandlerRef_t
 
typedef void(* taf_dcs_AsyncSessionHandlerFunc_t) (taf_dcs_ProfileRef_t profileRef, le_result_t result, void *contextPtr)
 
typedef void(* taf_dcs_SessionStateHandlerFunc_t) (taf_dcs_ProfileRef_t profileRef, taf_dcs_ConState_t state, const taf_dcs_StateInfo_t *LE_NONNULL infoPtr, void *contextPtr)
 
typedef void(* taf_dcs_RoamingStatusHandlerFunc_t) (const taf_dcs_RoamingStatusInd_t *LE_NONNULL roamingStatusIndPtr, void *contextPtr)
 
typedef void(* taf_dcs_ProfileListHandlerFunc_t) (le_result_t result, const taf_dcs_ProfileInfo_t *profileListPtr, size_t profileListSize, void *contextPtr)
 

Enumerations

enum  taf_dcs_DataBearerTechnology_t {
  TAF_DCS_DATA_BEARER_TECHNOLOGY_UNKNOWN = 0, TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA2000_1X = 1, TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA2000_EVDO = 2, TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA2000_EVDO_REVA = 3,
  TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA2000_EVDO_REVB = 4, TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA2000_EHRPD = 5, TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA2000_HRPD = 6, TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA_EVDO_FMC = 7,
  TAF_DCS_DATA_BEARER_TECHNOLOGY_3GPP2_WLAN = 8, TAF_DCS_DATA_BEARER_TECHNOLOGY_WCDMA = 9, TAF_DCS_DATA_BEARER_TECHNOLOGY_GPRS = 10, TAF_DCS_DATA_BEARER_TECHNOLOGY_HSDPA = 11,
  TAF_DCS_DATA_BEARER_TECHNOLOGY_HSUPA = 12, TAF_DCS_DATA_BEARER_TECHNOLOGY_EDGE = 13, TAF_DCS_DATA_BEARER_TECHNOLOGY_LTE = 14, TAF_DCS_DATA_BEARER_TECHNOLOGY_HSDPA_PLUS = 15,
  TAF_DCS_DATA_BEARER_TECHNOLOGY_DC_HSDPA_PLUS = 16, TAF_DCS_DATA_BEARER_TECHNOLOGY_HSPA = 17, TAF_DCS_DATA_BEARER_TECHNOLOGY_64_QAM = 18, TAF_DCS_DATA_BEARER_TECHNOLOGY_TD_SCDMA = 19,
  TAF_DCS_DATA_BEARER_TECHNOLOGY_GSM = 20, TAF_DCS_DATA_BEARER_TECHNOLOGY_3GPP_WLAN = 21, TAF_DCS_DATA_BEARER_TECHNOLOGY_5G = 22
}
 
enum  taf_dcs_ConState_t { TAF_DCS_DISCONNECTED = 0, TAF_DCS_CONNECTING = 1, TAF_DCS_CONNECTED = 2, TAF_DCS_DISCONNECTING = 3 }
 
enum  taf_dcs_Pdp_t { TAF_DCS_PDP_UNKNOWN = 0, TAF_DCS_PDP_IPV4 = 1, TAF_DCS_PDP_IPV6 = 2, TAF_DCS_PDP_IPV4V6 = 3 }
 
enum  taf_dcs_RoamingType_t { TAF_DCS_ROAMING_UNKNOWN = 0, TAF_DCS_ROAMING_DOMESTIC = 1, TAF_DCS_ROAMING_INTERNATIONAL = 2 }
 
enum  taf_dcs_Tech_t { TAF_DCS_TECH_UNKNOWN = 0, TAF_DCS_TECH_3GPP = 1, TAF_DCS_TECH_3GPP2 = 2, TAF_DCS_TECH_ANY = 3 }
 

Functions

LE_SHARED bool ifgen_taf_dcs_HasLocalBinding (void)
 
LE_SHARED void ifgen_taf_dcs_InitCommonData (void)
 
LE_SHARED void ifgen_taf_dcs_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_dcs_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 
LE_SHARED le_result_t ifgen_taf_dcs_StartSession (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef)
 
LE_SHARED void ifgen_taf_dcs_StartSessionAsync (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, taf_dcs_AsyncSessionHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED le_result_t ifgen_taf_dcs_StopSession (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef)
 
LE_SHARED void ifgen_taf_dcs_StopSessionAsync (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, taf_dcs_AsyncSessionHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetInterfaceName (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, char *ifName, size_t ifNameSize)
 
LE_SHARED taf_dcs_SessionStateHandlerRef_t ifgen_taf_dcs_AddSessionStateHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, taf_dcs_SessionStateHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_dcs_RemoveSessionStateHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_SessionStateHandlerRef_t handlerRef)
 
LE_SHARED taf_dcs_RoamingStatusHandlerRef_t ifgen_taf_dcs_AddRoamingStatusHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_RoamingStatusHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_dcs_RemoveRoamingStatusHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_RoamingStatusHandlerRef_t handlerRef)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetRoamingStatus (le_msg_SessionRef_t _ifgen_sessionRef, uint8_t phoneId, bool *isRoamingPtr, taf_dcs_RoamingType_t *typePtr)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetIPv4Address (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, char *ipAddr, size_t ipAddrSize)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetIPv4GatewayAddress (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, char *gatewayAddr, size_t gatewayAddrSize)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetIPv4DNSAddresses (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, char *dns1AddrStr, size_t dns1AddrStrSize, char *dns2AddrStr, size_t dns2AddrStrSize)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetIPv6Address (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, char *ipAddr, size_t ipAddrSize)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetIPv6GatewayAddress (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, char *gatewayAddr, size_t gatewayAddrSize)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetIPv6DNSAddresses (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, char *dns1AddrStr, size_t dns1AddrStrSize, char *dns2AddrStr, size_t dns2AddrStrSize)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetSessionState (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, taf_dcs_ConState_t *connectionStatePtr)
 
LE_SHARED bool ifgen_taf_dcs_IsIPv4 (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef)
 
LE_SHARED bool ifgen_taf_dcs_IsIPv6 (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetDataBearerTechnology (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, taf_dcs_DataBearerTechnology_t *dlDataBearerTechPtrPtr, taf_dcs_DataBearerTechnology_t *ulDataBearerTechPtrPtr)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetProfileList (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileInfo_t *profileListPtr, size_t *profileListSizePtr)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetProfileListEx (le_msg_SessionRef_t _ifgen_sessionRef, uint8_t phoneId, taf_dcs_ProfileInfo_t *profileListPtr, size_t *profileListSizePtr)
 
LE_SHARED uint32_t ifgen_taf_dcs_GetDefaultProfileIndex (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetDefaultPhoneIdAndProfileId (le_msg_SessionRef_t _ifgen_sessionRef, uint8_t *phoneIdPtr, uint32_t *profileIdPtr)
 
LE_SHARED le_result_t ifgen_taf_dcs_SetDefaultProfileIndex (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t profileId)
 
LE_SHARED le_result_t ifgen_taf_dcs_SetDefaultProfileIndexEx (le_msg_SessionRef_t _ifgen_sessionRef, uint8_t phoneId, uint32_t profileId)
 
LE_SHARED taf_dcs_ProfileRef_t ifgen_taf_dcs_GetProfile (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t profileId)
 
LE_SHARED taf_dcs_ProfileRef_t ifgen_taf_dcs_GetProfileEx (le_msg_SessionRef_t _ifgen_sessionRef, uint8_t phoneId, uint32_t profileId)
 
LE_SHARED uint32_t ifgen_taf_dcs_GetProfileIndex (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetPhoneId (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, uint8_t *phoneIdPtr)
 
LE_SHARED le_result_t ifgen_taf_dcs_SetAPN (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, const char *LE_NONNULL apnName)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetAPN (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, char *apnName, size_t apnNameSize)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetApnTypes (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, taf_dcs_ApnType_t *apnTypePtr)
 
LE_SHARED le_result_t ifgen_taf_dcs_SetPDP (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, taf_dcs_Pdp_t pdp)
 
LE_SHARED taf_dcs_Pdp_t ifgen_taf_dcs_GetPDP (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef)
 
LE_SHARED le_result_t ifgen_taf_dcs_SetAuthentication (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, taf_dcs_Auth_t auth, const char *LE_NONNULL userName, const char *LE_NONNULL password)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetAuthentication (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef, taf_dcs_Auth_t *authPtr, char *userName, size_t userNameSize, char *password, size_t passwordSize)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetProfileIdByInterfaceName (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL ifName, uint32_t *profileIdPtr)
 
LE_SHARED le_result_t ifgen_taf_dcs_GetPhoneIdByInterfaceName (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL ifName, uint8_t *phoneIdPtr)
 

Macro Definition Documentation

◆ IFGEN_TAF_DCS_PROTOCOL_ID

#define IFGEN_TAF_DCS_PROTOCOL_ID   "68cf9aa5086404da8037281238787893"

◆ IFGEN_TAF_DCS_MSG_SIZE

#define IFGEN_TAF_DCS_MSG_SIZE   2320

◆ TAF_DCS_NAME_MAX_LEN

#define TAF_DCS_NAME_MAX_LEN   64

The common name (string) maximum length.

◆ TAF_DCS_NAME_MAX_BYTES

#define TAF_DCS_NAME_MAX_BYTES   65

The common name (string) maximum Bytes.

◆ TAF_DCS_MAX_CALL_OBJ

#define TAF_DCS_MAX_CALL_OBJ   32

The maximum number of call contexts.

◆ TAF_DCS_MAX_SESSION_REF

#define TAF_DCS_MAX_SESSION_REF   32

The maximum number of session references.

◆ TAF_DCS_APN_NAME_MAX_LEN

#define TAF_DCS_APN_NAME_MAX_LEN   64

The APN name (string) maximum length.

◆ TAF_DCS_APN_NAME_MAX_BYTES

#define TAF_DCS_APN_NAME_MAX_BYTES   65

The APN name (string) maximum Bytes.

◆ TAF_DCS_USER_NAME_MAX_LEN

#define TAF_DCS_USER_NAME_MAX_LEN   64

The authorized username (string) maximum length.

◆ TAF_DCS_PASSWORD_NAME_MAX_LEN

#define TAF_DCS_PASSWORD_NAME_MAX_LEN   64

The authorized user's password (string) maximum length.

◆ TAF_DCS_USER_NAME_MAX_BYTES

#define TAF_DCS_USER_NAME_MAX_BYTES   65

The authorized user's username (string) maximum Bytes.

◆ TAF_DCS_PASSWORD_NAME_MAX_BYTES

#define TAF_DCS_PASSWORD_NAME_MAX_BYTES   65

The authorized user's password (string) maximum Bytes.

◆ TAF_DCS_IPV4_ADDR_MAX_LEN

#define TAF_DCS_IPV4_ADDR_MAX_LEN   16

The IPv4 address maximum length.

◆ TAF_DCS_IPV6_ADDR_MAX_LEN

#define TAF_DCS_IPV6_ADDR_MAX_LEN   46

The IPv6 address ("ffff:ffff:ffff:ffff:ffff:ffff:255:255:255:255") maximum length.

◆ TAF_DCS_DEFAULT_PROFILE

#define TAF_DCS_DEFAULT_PROFILE   1

The default cellular profile index.

◆ TAF_DCS_PROFILE_LIST_MAX_ENTRY

#define TAF_DCS_PROFILE_LIST_MAX_ENTRY   32

The maximum number of entries for cellular profiles.

◆ TAF_DCS_MAX_ASYNC_HANDLER_MAPPING

#define TAF_DCS_MAX_ASYNC_HANDLER_MAPPING   20

The maximum number of mappings for a handler session.

◆ TAF_DCS_AUTH_NONE

#define TAF_DCS_AUTH_NONE   0x1

The data profile authentication type.

◆ TAF_DCS_AUTH_PAP

#define TAF_DCS_AUTH_PAP   0x2

◆ TAF_DCS_AUTH_CHAP

#define TAF_DCS_AUTH_CHAP   0x4

◆ TAF_DCS_APN_TYPE_DEFAULT

#define TAF_DCS_APN_TYPE_DEFAULT   0x1

The APN type

◆ TAF_DCS_APN_TYPE_IMS

#define TAF_DCS_APN_TYPE_IMS   0x2

◆ TAF_DCS_APN_TYPE_MMS

#define TAF_DCS_APN_TYPE_MMS   0x4

◆ TAF_DCS_APN_TYPE_DUN

#define TAF_DCS_APN_TYPE_DUN   0x8

◆ TAF_DCS_APN_TYPE_SUPL

#define TAF_DCS_APN_TYPE_SUPL   0x10

◆ TAF_DCS_APN_TYPE_HIPRI

#define TAF_DCS_APN_TYPE_HIPRI   0x20

◆ TAF_DCS_APN_TYPE_FOTA

#define TAF_DCS_APN_TYPE_FOTA   0x40

◆ TAF_DCS_APN_TYPE_CBS

#define TAF_DCS_APN_TYPE_CBS   0x80

◆ TAF_DCS_APN_TYPE_IA

#define TAF_DCS_APN_TYPE_IA   0x100

◆ TAF_DCS_APN_TYPE_EMERGENCY

#define TAF_DCS_APN_TYPE_EMERGENCY   0x200

◆ TAF_DCS_APN_TYPE_UT

#define TAF_DCS_APN_TYPE_UT   0x400

◆ TAF_DCS_APN_TYPE_MCX

#define TAF_DCS_APN_TYPE_MCX   0x800

Typedef Documentation

◆ taf_dcs_ProfileRef_t

typedef struct taf_dcs_Profile* taf_dcs_ProfileRef_t

Reference to the cellular profile context.

◆ taf_dcs_CallRef_t

typedef struct taf_dcs_Call* taf_dcs_CallRef_t

Reference to the data call session context.

◆ taf_dcs_Auth_t

typedef uint32_t taf_dcs_Auth_t

◆ taf_dcs_ApnType_t

typedef uint32_t taf_dcs_ApnType_t

◆ taf_dcs_SessionStateHandlerRef_t

typedef struct taf_dcs_SessionStateHandler* taf_dcs_SessionStateHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_dcs_SessionState'

◆ taf_dcs_RoamingStatusHandlerRef_t

typedef struct taf_dcs_RoamingStatusHandler* taf_dcs_RoamingStatusHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_dcs_RoamingStatus'

◆ taf_dcs_AsyncSessionHandlerFunc_t

typedef void(* taf_dcs_AsyncSessionHandlerFunc_t) (taf_dcs_ProfileRef_t profileRef, le_result_t result, void *contextPtr)

The handler for asynchronous session start or stop result response.

◆ taf_dcs_SessionStateHandlerFunc_t

typedef void(* taf_dcs_SessionStateHandlerFunc_t) (taf_dcs_ProfileRef_t profileRef, taf_dcs_ConState_t state, const taf_dcs_StateInfo_t *LE_NONNULL infoPtr, void *contextPtr)

The data call session handler.

◆ taf_dcs_RoamingStatusHandlerFunc_t

typedef void(* taf_dcs_RoamingStatusHandlerFunc_t) (const taf_dcs_RoamingStatusInd_t *LE_NONNULL roamingStatusIndPtr, void *contextPtr)

Handler for roaming status.

◆ taf_dcs_ProfileListHandlerFunc_t

typedef void(* taf_dcs_ProfileListHandlerFunc_t) (le_result_t result, const taf_dcs_ProfileInfo_t *profileListPtr, size_t profileListSize, void *contextPtr)

The handler of the requesting data profile list.

Enumeration Type Documentation

◆ taf_dcs_DataBearerTechnology_t

enum taf_dcs_DataBearerTechnology_t

The supported data bearer technology.

Enumerator
TAF_DCS_DATA_BEARER_TECHNOLOGY_UNKNOWN 

Unknown.

TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA2000_1X 

CDMA 1XF.

TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA2000_EVDO 

CDMA Rev 0.

TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA2000_EVDO_REVA 

CDMA Rev A.

TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA2000_EVDO_REVB 

CDMA Rev B.

TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA2000_EHRPD 

CDMA EHPRD.

TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA2000_HRPD 

CDMA HPRD.

TAF_DCS_DATA_BEARER_TECHNOLOGY_CDMA_EVDO_FMC 

CDMA FMC.

TAF_DCS_DATA_BEARER_TECHNOLOGY_3GPP2_WLAN 

IWLAN.

TAF_DCS_DATA_BEARER_TECHNOLOGY_WCDMA 

WCDMA (UMTS).

TAF_DCS_DATA_BEARER_TECHNOLOGY_GPRS 

GPRS.

TAF_DCS_DATA_BEARER_TECHNOLOGY_HSDPA 

HSDPA.

TAF_DCS_DATA_BEARER_TECHNOLOGY_HSUPA 

HSUPA.

TAF_DCS_DATA_BEARER_TECHNOLOGY_EDGE 

EDGE.

TAF_DCS_DATA_BEARER_TECHNOLOGY_LTE 

LTE.

TAF_DCS_DATA_BEARER_TECHNOLOGY_HSDPA_PLUS 

HSDPA_PLUS.

TAF_DCS_DATA_BEARER_TECHNOLOGY_DC_HSDPA_PLUS 

DC_HSDPA_PLUS.

TAF_DCS_DATA_BEARER_TECHNOLOGY_HSPA 

HSPA.

TAF_DCS_DATA_BEARER_TECHNOLOGY_64_QAM 

64 QAM.

TAF_DCS_DATA_BEARER_TECHNOLOGY_TD_SCDMA 

TDS-CDMA.

TAF_DCS_DATA_BEARER_TECHNOLOGY_GSM 

GSM.

TAF_DCS_DATA_BEARER_TECHNOLOGY_3GPP_WLAN 

IWLAN.

TAF_DCS_DATA_BEARER_TECHNOLOGY_5G 

NR5G.

◆ taf_dcs_ConState_t

enum taf_dcs_ConState_t

The supported data cellular call connection event.

Enumerator
TAF_DCS_DISCONNECTED 

Disconnected state.

TAF_DCS_CONNECTING 

Connecting state.

TAF_DCS_CONNECTED 

Connected state.

TAF_DCS_DISCONNECTING 

Disconnecting state.

◆ taf_dcs_Pdp_t

enum taf_dcs_Pdp_t

The data profile PDP type.

Enumerator
TAF_DCS_PDP_UNKNOWN 

Unknown.

TAF_DCS_PDP_IPV4 

IPv4.

TAF_DCS_PDP_IPV6 

IPv6.

TAF_DCS_PDP_IPV4V6 

IPv4 and IPv6.

◆ taf_dcs_RoamingType_t

enum taf_dcs_RoamingType_t

The roaming type.

Enumerator
TAF_DCS_ROAMING_UNKNOWN 

Unknown.

TAF_DCS_ROAMING_DOMESTIC 

Device is in a domestic roaming network.

TAF_DCS_ROAMING_INTERNATIONAL 

Device is in an international roaming network.

◆ taf_dcs_Tech_t

enum taf_dcs_Tech_t

The data profile technology type.

Enumerator
TAF_DCS_TECH_UNKNOWN 

Unknown.

TAF_DCS_TECH_3GPP 

3GPP.

TAF_DCS_TECH_3GPP2 

3GPP2.

TAF_DCS_TECH_ANY 

Any.

Function Documentation

◆ ifgen_taf_dcs_HasLocalBinding()

LE_SHARED bool ifgen_taf_dcs_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_taf_dcs_InitCommonData()

LE_SHARED void ifgen_taf_dcs_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_taf_dcs_CleanupCommonData()

LE_SHARED void ifgen_taf_dcs_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_taf_dcs_OpenSession()

LE_SHARED le_result_t ifgen_taf_dcs_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_taf_dcs_StartSession()

LE_SHARED le_result_t ifgen_taf_dcs_StartSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_dcs_ProfileRef_t  profileRef 
)

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.

◆ ifgen_taf_dcs_StartSessionAsync()

LE_SHARED void ifgen_taf_dcs_StartSessionAsync ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_StopSession()

LE_SHARED le_result_t ifgen_taf_dcs_StopSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_StopSessionAsync()

LE_SHARED void ifgen_taf_dcs_StopSessionAsync ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_GetInterfaceName()

LE_SHARED le_result_t ifgen_taf_dcs_GetInterfaceName ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_AddSessionStateHandler()

LE_SHARED taf_dcs_SessionStateHandlerRef_t ifgen_taf_dcs_AddSessionStateHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_RemoveSessionStateHandler()

LE_SHARED void ifgen_taf_dcs_RemoveSessionStateHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_dcs_SessionStateHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_dcs_SessionState'

Parameters
[in]handlerRef

◆ ifgen_taf_dcs_AddRoamingStatusHandler()

LE_SHARED taf_dcs_RoamingStatusHandlerRef_t ifgen_taf_dcs_AddRoamingStatusHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_RemoveRoamingStatusHandler()

LE_SHARED void ifgen_taf_dcs_RemoveRoamingStatusHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_dcs_RoamingStatusHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_dcs_RoamingStatus'

Parameters
[in]handlerRef

◆ ifgen_taf_dcs_GetRoamingStatus()

LE_SHARED le_result_t ifgen_taf_dcs_GetRoamingStatus ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_GetIPv4Address()

LE_SHARED le_result_t ifgen_taf_dcs_GetIPv4Address ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_GetIPv4GatewayAddress()

LE_SHARED le_result_t ifgen_taf_dcs_GetIPv4GatewayAddress ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_GetIPv4DNSAddresses()

LE_SHARED le_result_t ifgen_taf_dcs_GetIPv4DNSAddresses ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_GetIPv6Address()

LE_SHARED le_result_t ifgen_taf_dcs_GetIPv6Address ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_GetIPv6GatewayAddress()

LE_SHARED le_result_t ifgen_taf_dcs_GetIPv6GatewayAddress ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_GetIPv6DNSAddresses()

LE_SHARED le_result_t ifgen_taf_dcs_GetIPv6DNSAddresses ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_GetSessionState()

LE_SHARED le_result_t ifgen_taf_dcs_GetSessionState ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_IsIPv4()

LE_SHARED bool ifgen_taf_dcs_IsIPv4 ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_IsIPv6()

LE_SHARED bool ifgen_taf_dcs_IsIPv6 ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_GetDataBearerTechnology()

LE_SHARED le_result_t ifgen_taf_dcs_GetDataBearerTechnology ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_GetProfileList()

LE_SHARED le_result_t ifgen_taf_dcs_GetProfileList ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_GetProfileListEx()

LE_SHARED le_result_t ifgen_taf_dcs_GetProfileListEx ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_GetDefaultProfileIndex()

LE_SHARED uint32_t ifgen_taf_dcs_GetDefaultProfileIndex ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets the default profile index.

Returns
  • uint32 – The profile index.

◆ ifgen_taf_dcs_GetDefaultPhoneIdAndProfileId()

LE_SHARED le_result_t ifgen_taf_dcs_GetDefaultPhoneIdAndProfileId ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_SetDefaultProfileIndex()

LE_SHARED le_result_t ifgen_taf_dcs_SetDefaultProfileIndex ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_SetDefaultProfileIndexEx()

LE_SHARED le_result_t ifgen_taf_dcs_SetDefaultProfileIndexEx ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_GetProfile()

LE_SHARED taf_dcs_ProfileRef_t ifgen_taf_dcs_GetProfile ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_GetProfileEx()

LE_SHARED taf_dcs_ProfileRef_t ifgen_taf_dcs_GetProfileEx ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_GetProfileIndex()

LE_SHARED uint32_t ifgen_taf_dcs_GetProfileIndex ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_GetPhoneId()

LE_SHARED le_result_t ifgen_taf_dcs_GetPhoneId ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_SetAPN()

LE_SHARED le_result_t ifgen_taf_dcs_SetAPN ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_GetAPN()

LE_SHARED le_result_t ifgen_taf_dcs_GetAPN ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_GetApnTypes()

LE_SHARED le_result_t ifgen_taf_dcs_GetApnTypes ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_SetPDP()

LE_SHARED le_result_t ifgen_taf_dcs_SetPDP ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_GetPDP()

LE_SHARED taf_dcs_Pdp_t ifgen_taf_dcs_GetPDP ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_SetAuthentication()

LE_SHARED le_result_t ifgen_taf_dcs_SetAuthentication ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_GetAuthentication()

LE_SHARED le_result_t ifgen_taf_dcs_GetAuthentication ( le_msg_SessionRef_t  _ifgen_sessionRef,
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

◆ ifgen_taf_dcs_GetProfileIdByInterfaceName()

LE_SHARED le_result_t ifgen_taf_dcs_GetProfileIdByInterfaceName ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.

◆ ifgen_taf_dcs_GetPhoneIdByInterfaceName()

LE_SHARED le_result_t ifgen_taf_dcs_GetPhoneIdByInterfaceName ( le_msg_SessionRef_t  _ifgen_sessionRef,
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.