#include "legato.h"
#include "taf_types_interface.h"
#include "taf_dcs_common.h"

Typedefs
typedef void(*	taf_dcs_DisconnectHandler_t) (void *)

Functions
void	taf_dcs_ConnectService (void)

le_result_t	taf_dcs_TryConnectService (void)

LE_FULL_API void	taf_dcs_SetServerDisconnectHandler (taf_dcs_DisconnectHandler_t disconnectHandler, void *contextPtr)

LE_FULL_API void	taf_dcs_SetNonExitServerDisconnectHandler (taf_dcs_DisconnectHandler_t disconnectHandler, void *contextPtr)

void	taf_dcs_DisconnectService (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)

Typedef Documentation

◆ taf_dcs_DisconnectHandler_t

typedef void(* taf_dcs_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

◆ taf_dcs_ConnectService()

void taf_dcs_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.

◆ taf_dcs_TryConnectService()

le_result_t taf_dcs_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.

Returns

LE_OK if the client connected successfully to the service.
LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
LE_COMM_ERROR if the Service Directory cannot be reached.

◆ taf_dcs_SetServerDisconnectHandler()

LE_FULL_API void taf_dcs_SetServerDisconnectHandler	(	taf_dcs_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.

◆ taf_dcs_SetNonExitServerDisconnectHandler()

LE_FULL_API void taf_dcs_SetNonExitServerDisconnectHandler	(	taf_dcs_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.

Warning: When using the API, it needs the application developer to handle some cases like re-connecting and recycling the resources. For most of cases, it is safe to use SetServerDisconnectHandler.

◆ taf_dcs_DisconnectService()

void taf_dcs_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_dcs_StartSession()

le_result_t taf_dcs_StartSession ( 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] profileRef The 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]	profileRef	The profile reference.
[in]	handlerPtr	The 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] profileRef The 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]	profileRef	The profile reference.
[in]	handlerPtr	The 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]	profileRef	The profile reference.
[out]	ifName	The 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]	profileRef	The profile reference.
[in]	handlerPtr	The 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]	handlerPtr	Handler 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]	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.

◆ 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]	profileRef	The profile reference.
[out]	ipAddr	The 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]	profileRef	The profile reference.
[out]	gatewayAddr	The 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]	profileRef	The profile reference.
[out]	dns1AddrStr	The IPv4 primary DNS address.
[in]	dns1AddrStrSize
[out]	dns2AddrStr	The 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]	profileRef	The profile reference.
[out]	ipAddr	The 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]	profileRef	The profile reference.
[out]	gatewayAddr	The 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]	profileRef	The profile reference.
[out]	dns1AddrStr	The IPv6 primary DNS address.
[in]	dns1AddrStrSize
[out]	dns2AddrStr	The 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]	profileRef	The profile reference.
[out]	connectionStatePtr	The 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] profileRef The 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] profileRef The 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]	profileRef	The profile reference.
[out]	dlDataBearerTechPtrPtr	The downlink data bearer technology.
[out]	ulDataBearerTechPtrPtr	The 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]	profileListPtr	The 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]	phoneId	The phone ID.
[out]	profileListPtr	The 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]	phoneIdPtr	The phone ID.
[out]	profileIdPtr	The 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] profileId The 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]	phoneId	The phone ID.
[in]	profileId	The 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] profileId The 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]	phoneId	The phone ID.
[in]	profileId	The 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] profileRef The 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]	profileRef	The profile reference.
[out]	phoneIdPtr	The 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]	profileRef	The profile reference.
[in]	apnName	The 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]	profileRef	The profile reference.
[out]	apnName	The 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]	profileRef	The profile reference.
[out]	apnTypePtr	The 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]	profileRef	The profile reference.
[in]	pdp	The 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] profileRef The 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]	profileRef	The profile reference.
[in]	auth	The authentication type.
[in]	userName	The username.
[in]	password	The 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]	profileRef	The profile reference.
[out]	authPtr	The authentication type.
[out]	userName	The username.
[in]	userNameSize
[out]	password	The 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]	ifName	The interface name.
[out]	profileIdPtr	The 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]	ifName	The interface name.
[out]	phoneIdPtr	The phone ID.

Typedefs

Functions

Typedef Documentation

◆ taf_dcs_DisconnectHandler_t

Function Documentation

◆ taf_dcs_ConnectService()

◆ taf_dcs_TryConnectService()

◆ taf_dcs_SetServerDisconnectHandler()

◆ taf_dcs_SetNonExitServerDisconnectHandler()

◆ taf_dcs_DisconnectService()

◆ taf_dcs_StartSession()

◆ taf_dcs_StartSessionAsync()

◆ taf_dcs_StopSession()

◆ taf_dcs_StopSessionAsync()

◆ taf_dcs_GetInterfaceName()

◆ taf_dcs_AddSessionStateHandler()

◆ taf_dcs_RemoveSessionStateHandler()

◆ taf_dcs_AddRoamingStatusHandler()

◆ taf_dcs_RemoveRoamingStatusHandler()

◆ taf_dcs_GetRoamingStatus()

◆ taf_dcs_GetIPv4Address()

◆ taf_dcs_GetIPv4GatewayAddress()

◆ taf_dcs_GetIPv4DNSAddresses()

◆ taf_dcs_GetIPv6Address()

◆ taf_dcs_GetIPv6GatewayAddress()

◆ taf_dcs_GetIPv6DNSAddresses()

◆ taf_dcs_GetSessionState()

◆ taf_dcs_IsIPv4()

◆ taf_dcs_IsIPv6()

◆ taf_dcs_GetDataBearerTechnology()

◆ taf_dcs_GetProfileList()

◆ taf_dcs_GetProfileListEx()

◆ taf_dcs_GetDefaultProfileIndex()

◆ taf_dcs_GetDefaultPhoneIdAndProfileId()

◆ taf_dcs_SetDefaultProfileIndex()

◆ taf_dcs_SetDefaultProfileIndexEx()

◆ taf_dcs_GetProfile()

◆ taf_dcs_GetProfileEx()

◆ taf_dcs_GetProfileIndex()

◆ taf_dcs_GetPhoneId()

◆ taf_dcs_SetAPN()

◆ taf_dcs_GetAPN()

◆ taf_dcs_GetApnTypes()

◆ taf_dcs_SetPDP()

◆ taf_dcs_GetPDP()

◆ taf_dcs_SetAuthentication()

◆ taf_dcs_GetAuthentication()

◆ taf_dcs_GetProfileIdByInterfaceName()

◆ taf_dcs_GetPhoneIdByInterfaceName()