Snapdragon® Telematics Application Framework (TelAF) Interface Specification
taf_net_common.h File Reference
#include "legato.h"
#include "taf_types_common.h"

Go to the source code of this file.

Data Structures

struct  taf_net_DestNatChangeInd_t
 
struct  taf_net_InterfaceInfo_t
 
struct  taf_net_DnsServerAddresses_t
 
struct  taf_net_RouteChangeInd_t
 
struct  taf_net_GatewayChangeInd_t
 
struct  taf_net_DNSChangeInd_t
 
struct  taf_net_L2tpSessionConfig_t
 

Macros

#define IFGEN_TAF_NET_PROTOCOL_ID   "4a13659273f4befc9ad9436efbdeba72"
 
#define IFGEN_TAF_NET_MSG_SIZE   1384
 
#define TAF_NET_INTERFACE_NAME_MAX_NUM   36
 
#define TAF_NET_INTERFACE_NAME_MAX_LEN   30
 
#define TAF_NET_IPV4_ADDR_MAX_LEN   16
 
#define TAF_NET_IPV6_ADDR_MAX_LEN   46
 
#define TAF_NET_IP_ADDR_MAX_LEN   46
 
#define TAF_NET_MAC_ADDR_MAX_LEN   17
 
#define TAF_NET_MAX_NAT_ENTRY   50
 
#define TAF_NET_MAX_VLAN_ENTRY   100
 
#define TAF_NET_MAX_VLAN_ENTRY_LIST   2
 
#define TAF_NET_MAX_VLAN_INTERFACE   5
 
#define TAF_NET_L2TP_MAX_TUNNEL_NUMBER   2
 
#define TAF_NET_L2TP_MAX_SESSION_NUMBER_PER_TUNNEL   3
 
#define TAF_NET_SOCKSV5_MAX_USERNAME_LEN   255
 
#define TAF_NET_SOCKSV5_MAX_MAPPING_POOL   2
 
#define TAF_NET_MAX_GSB_LIST_NUM   2
 
#define TAF_NET_MAX_GSB_NUM   10
 

Typedefs

typedef struct taf_net_DestNatEntryList * taf_net_DestNatEntryListRef_t
 
typedef struct taf_net_DestNatEntry * taf_net_DestNatEntryRef_t
 
typedef struct taf_net_Vlan * taf_net_VlanRef_t
 
typedef struct taf_net_VlanEntryList * taf_net_VlanEntryListRef_t
 
typedef struct taf_net_VlanEntry * taf_net_VlanEntryRef_t
 
typedef struct taf_net_VlanIfList * taf_net_VlanIfListRef_t
 
typedef struct taf_net_VlanIf * taf_net_VlanIfRef_t
 
typedef struct taf_net_TunnelEntryList * taf_net_TunnelEntryListRef_t
 
typedef struct taf_net_TunnelEntry * taf_net_TunnelEntryRef_t
 
typedef struct taf_net_Tunnel * taf_net_TunnelRef_t
 
typedef struct taf_net_GsbList * taf_net_GsbListRef_t
 
typedef struct taf_net_Gsb * taf_net_GsbRef_t
 
typedef struct taf_net_RouteChangeHandler * taf_net_RouteChangeHandlerRef_t
 
typedef struct taf_net_GatewayChangeHandler * taf_net_GatewayChangeHandlerRef_t
 
typedef struct taf_net_DNSChangeHandler * taf_net_DNSChangeHandlerRef_t
 
typedef struct taf_net_DestNatChangeHandler * taf_net_DestNatChangeHandlerRef_t
 
typedef void(* taf_net_RouteChangeHandlerFunc_t) (const taf_net_RouteChangeInd_t *LE_NONNULL routeIndPtr, void *contextPtr)
 
typedef void(* taf_net_GatewayChangeHandlerFunc_t) (const taf_net_GatewayChangeInd_t *LE_NONNULL gatewayIndPtr, void *contextPtr)
 
typedef void(* taf_net_DNSChangeHandlerFunc_t) (const taf_net_DNSChangeInd_t *LE_NONNULL DNSIndPtr, void *contextPtr)
 
typedef void(* taf_net_DestNatChangeHandlerFunc_t) (const taf_net_DestNatChangeInd_t *LE_NONNULL destNatIndPtr, void *contextPtr)
 
typedef void(* taf_net_AsyncTunnelHandlerFunc_t) (taf_net_TunnelRef_t tunnelRef, le_result_t result, void *contextPtr)
 
typedef void(* taf_net_AsyncL2tpHandlerFunc_t) (le_result_t result, void *contextPtr)
 
typedef void(* taf_net_AsyncSocksHandlerFunc_t) (le_result_t result, void *contextPtr)
 

Enumerations

enum  taf_net_IpProto_t { TAF_NET_TCP = 6, TAF_NET_UDP = 17 }
 
enum  taf_net_NetAction_t { TAF_NET_DELETE = 0, TAF_NET_ADD = 1 }
 
enum  taf_net_NetIpType_t { TAF_NET_IPV4 = 0, TAF_NET_IPV6 = 1 }
 
enum  taf_net_TechType_t { TAF_NET_TECH_CELLULAR = 0, TAF_NET_TECH_WIFI = 1, TAF_NET_TECH_ETHERNET = 2 }
 
enum  taf_net_State_t { TAF_NET_STATE_DOWN = 0, TAF_NET_STATE_UP = 1 }
 
enum  taf_net_L2tpEncapProtocol_t { TAF_NET_L2TP_NONE = 0, TAF_NET_L2TP_IP = 1, TAF_NET_L2TP_UDP = 2 }
 
enum  taf_net_IpFamilyType_t { TAF_NET_L2TP_UNKNOWN = -1, TAF_NET_L2TP_IPV4 = 4, TAF_NET_L2TP_IPV6 = 6, TAF_NET_L2TP_IPV4V6 = 10 }
 
enum  taf_net_VlanIfType_t {
  TAF_NET_IFACE_UNKNOWN = 0, TAF_NET_WLAN = 1, TAF_NET_ETH = 2, TAF_NET_ECM = 3,
  TAF_NET_RNDIS = 4, TAF_NET_MHI = 5
}
 
enum  taf_net_BindingAction_t { TAF_NET_BIND = 0, TAF_NET_UNBIND = 1 }
 
enum  taf_net_DeviceMode_t { TAF_NET_DEVICE_UNKNOWN = -1, TAF_NET_DEVICE_NONE = 0, TAF_NET_DEVICE_L2L = 1, TAF_NET_DEVICE_E2E = 2 }
 
enum  taf_net_AuthMethod_t { TAF_NET_SOCKS_UNKNOWN = -1, TAF_NET_SOCKS_NONE = 0, TAF_NET_SOCKS_USER_PASSWD = 1 }
 
enum  taf_net_GsbIfType_t { TAF_NET_GSB_UNKNOWN = 0, TAF_NET_GSB_WLAN_AP = 1, TAF_NET_GSB_WLAN_STA = 2, TAF_NET_GSB_ETH = 3 }
 

Functions

LE_SHARED bool ifgen_taf_net_HasLocalBinding (void)
 
LE_SHARED void ifgen_taf_net_InitCommonData (void)
 
LE_SHARED void ifgen_taf_net_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_net_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 
LE_SHARED taf_net_RouteChangeHandlerRef_t ifgen_taf_net_AddRouteChangeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_RouteChangeHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_net_RemoveRouteChangeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_RouteChangeHandlerRef_t handlerRef)
 
LE_SHARED taf_net_GatewayChangeHandlerRef_t ifgen_taf_net_AddGatewayChangeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_GatewayChangeHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_net_RemoveGatewayChangeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_GatewayChangeHandlerRef_t handlerRef)
 
LE_SHARED taf_net_DNSChangeHandlerRef_t ifgen_taf_net_AddDNSChangeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_DNSChangeHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_net_RemoveDNSChangeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_DNSChangeHandlerRef_t handlerRef)
 
LE_SHARED taf_net_DestNatChangeHandlerRef_t ifgen_taf_net_AddDestNatChangeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_DestNatChangeHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_net_RemoveDestNatChangeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_DestNatChangeHandlerRef_t handlerRef)
 
LE_SHARED le_result_t ifgen_taf_net_GetInterfaceList (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_InterfaceInfo_t *ifInfoListPtr, size_t *ifInfoListSizePtr)
 
LE_SHARED le_result_t ifgen_taf_net_ChangeRoute (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL interfaceName, const char *LE_NONNULL destAddr, const char *LE_NONNULL subnetMask, uint16_t metric, taf_net_NetAction_t isAdd)
 
LE_SHARED le_result_t ifgen_taf_net_BackupDefaultGW (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_net_RestoreDefaultGW (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_net_SetDefaultGW (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL ifName)
 
LE_SHARED le_result_t ifgen_taf_net_GetInterfaceGW (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL ifName, char *ipv4Addr, size_t ipv4AddrSize, char *ipv6Addr, size_t ipv6AddrSize)
 
LE_SHARED le_result_t ifgen_taf_net_SetDNS (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL ifName)
 
LE_SHARED le_result_t ifgen_taf_net_GetInterfaceDNS (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL ifName, taf_net_DnsServerAddresses_t *dnsServerAddressesPtr)
 
LE_SHARED le_result_t ifgen_taf_net_AddDestNatEntryOnDefaultPdn (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL privateIpAddr, uint16_t privatePort, uint16_t globalPort, taf_net_IpProto_t ipProto)
 
LE_SHARED le_result_t ifgen_taf_net_RemoveDestNatEntryOnDefaultPdn (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL privateIpAddr, uint16_t privatePort, uint16_t globalPort, taf_net_IpProto_t ipProto)
 
LE_SHARED le_result_t ifgen_taf_net_AddDestNatEntryOnDemandPdn (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t profileId, const char *LE_NONNULL privateIpAddr, uint16_t privatePort, uint16_t globalPort, taf_net_IpProto_t ipProto)
 
LE_SHARED le_result_t ifgen_taf_net_RemoveDestNatEntryOnDemandPdn (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t profileId, const char *LE_NONNULL privateIpAddr, uint16_t privatePort, uint16_t globalPort, taf_net_IpProto_t ipProto)
 
LE_SHARED taf_net_DestNatEntryListRef_t ifgen_taf_net_GetDestNatEntryListOnDefaultPdn (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED taf_net_DestNatEntryListRef_t ifgen_taf_net_GetDestNatEntryListOnDemandPdn (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t profileId)
 
LE_SHARED taf_net_DestNatEntryRef_t ifgen_taf_net_GetFirstDestNatEntry (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_DestNatEntryListRef_t destNatEntryListRef)
 
LE_SHARED taf_net_DestNatEntryRef_t ifgen_taf_net_GetNextDestNatEntry (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_DestNatEntryListRef_t destNatEntryListRef)
 
LE_SHARED le_result_t ifgen_taf_net_GetDestNatEntryDetails (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_DestNatEntryRef_t destNatEntryRef, char *privateIpAddr, size_t privateIpAddrSize, uint16_t *privatePortPtr, uint16_t *globalPortPtr, taf_net_IpProto_t *ipProtoPtr)
 
LE_SHARED le_result_t ifgen_taf_net_DeleteDestNatEntryList (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_DestNatEntryListRef_t destNatEntryListRef)
 
LE_SHARED taf_net_VlanRef_t ifgen_taf_net_CreateVlan (le_msg_SessionRef_t _ifgen_sessionRef, uint16_t vlanId, bool isAccelerated)
 
LE_SHARED le_result_t ifgen_taf_net_SetVlanPriority (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanRef_t vlanRef, uint8_t priority)
 
LE_SHARED le_result_t ifgen_taf_net_RemoveVlan (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanRef_t vlanRef)
 
LE_SHARED taf_net_VlanRef_t ifgen_taf_net_GetVlanById (le_msg_SessionRef_t _ifgen_sessionRef, uint16_t vlanId)
 
LE_SHARED le_result_t ifgen_taf_net_AddVlanInterface (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanRef_t vlanRef, taf_net_VlanIfType_t ifType)
 
LE_SHARED le_result_t ifgen_taf_net_RemoveVlanInterface (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanRef_t vlanRef, taf_net_VlanIfType_t ifType)
 
LE_SHARED taf_net_VlanIfListRef_t ifgen_taf_net_GetVlanInterfaceList (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanRef_t vlanRef)
 
LE_SHARED taf_net_VlanIfRef_t ifgen_taf_net_GetFirstVlanInterface (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanIfListRef_t vlanIfListRef)
 
LE_SHARED taf_net_VlanIfRef_t ifgen_taf_net_GetNextVlanInterface (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanIfListRef_t vlanIfListRef)
 
LE_SHARED le_result_t ifgen_taf_net_DeleteVlanInterfaceList (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanIfListRef_t vlanIfListRef)
 
LE_SHARED taf_net_VlanIfType_t ifgen_taf_net_GetVlanInterfaceType (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanIfRef_t vlanIfRef)
 
LE_SHARED le_result_t ifgen_taf_net_GetVlanPriority (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanIfRef_t vlanIfRef, uint8_t *priorityPtr)
 
LE_SHARED taf_net_VlanEntryListRef_t ifgen_taf_net_GetVlanEntryList (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED taf_net_VlanEntryRef_t ifgen_taf_net_GetFirstVlanEntry (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanEntryListRef_t vlanEntryListRef)
 
LE_SHARED taf_net_VlanEntryRef_t ifgen_taf_net_GetNextVlanEntry (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanEntryListRef_t vlanEntryListRef)
 
LE_SHARED le_result_t ifgen_taf_net_DeleteVlanEntryList (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanEntryListRef_t vlanEntryListRef)
 
LE_SHARED int16_t ifgen_taf_net_GetVlanId (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanEntryRef_t vlanEntryRef)
 
LE_SHARED le_result_t ifgen_taf_net_IsVlanAccelerated (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanEntryRef_t vlanEntryRef, bool *isAcceleratedPtr)
 
LE_SHARED int32_t ifgen_taf_net_GetVlanBoundProfileId (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanEntryRef_t vlanEntryRef)
 
LE_SHARED le_result_t ifgen_taf_net_GetVlanBoundPhoneId (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanEntryRef_t vlanEntryRef, uint8_t *phoneIdPtr)
 
LE_SHARED le_result_t ifgen_taf_net_BindVlanWithProfile (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanRef_t vlanRef, uint32_t profileId)
 
LE_SHARED le_result_t ifgen_taf_net_BindVlanWithProfileEx (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanRef_t vlanRef, uint8_t phoneId, uint32_t profileId)
 
LE_SHARED le_result_t ifgen_taf_net_UnbindVlanFromProfile (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_VlanRef_t vlanRef)
 
LE_SHARED le_result_t ifgen_taf_net_EnableL2tp (le_msg_SessionRef_t _ifgen_sessionRef, bool enableMss, bool enableMtu, uint32_t mtuSize)
 
LE_SHARED void ifgen_taf_net_EnableL2tpAsync (le_msg_SessionRef_t _ifgen_sessionRef, bool enableMss, bool enableMtu, uint32_t mtuSize, taf_net_AsyncL2tpHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED le_result_t ifgen_taf_net_DisableL2tp (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED void ifgen_taf_net_DisableL2tpAsync (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_AsyncL2tpHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED bool ifgen_taf_net_IsL2tpEnabled (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED bool ifgen_taf_net_IsL2tpMssEnabled (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED bool ifgen_taf_net_IsL2tpMtuEnabled (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED uint32_t ifgen_taf_net_GetL2tpMtuSize (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED taf_net_TunnelRef_t ifgen_taf_net_CreateTunnel (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_L2tpEncapProtocol_t encaProto, uint32_t locId, uint32_t peerId, const char *LE_NONNULL peerIpAddr, const char *LE_NONNULL ifName)
 
LE_SHARED le_result_t ifgen_taf_net_RemoveTunnel (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelRef_t tunnelRef)
 
LE_SHARED le_result_t ifgen_taf_net_SetTunnelUdpPort (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelRef_t tunnelRef, uint32_t localUdpPort, uint32_t peerUdpPort)
 
LE_SHARED le_result_t ifgen_taf_net_AddSession (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelRef_t tunnelRef, uint32_t locId, uint32_t peerId)
 
LE_SHARED le_result_t ifgen_taf_net_RemoveSession (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelRef_t tunnelRef, uint32_t locId, uint32_t peerId)
 
LE_SHARED le_result_t ifgen_taf_net_StartTunnel (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelRef_t tunnelRef)
 
LE_SHARED void ifgen_taf_net_StartTunnelAsync (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelRef_t tunnelRef, taf_net_AsyncTunnelHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED le_result_t ifgen_taf_net_StopTunnel (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelRef_t tunnelRef)
 
LE_SHARED void ifgen_taf_net_StopTunnelAsync (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelRef_t tunnelRef, taf_net_AsyncTunnelHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED taf_net_TunnelRef_t ifgen_taf_net_GetTunnelRefById (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t locId)
 
LE_SHARED taf_net_TunnelEntryListRef_t ifgen_taf_net_GetTunnelEntryList (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED taf_net_TunnelEntryRef_t ifgen_taf_net_GetFirstTunnelEntry (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryListRef_t tunnelEntryListRef)
 
LE_SHARED taf_net_TunnelEntryRef_t ifgen_taf_net_GetNextTunnelEntry (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryListRef_t tunnelEntryListRef)
 
LE_SHARED le_result_t ifgen_taf_net_DeleteTunnelEntryList (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryListRef_t tunnelEntryListRef)
 
LE_SHARED taf_net_L2tpEncapProtocol_t ifgen_taf_net_GetTunnelEncapProto (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryRef_t tunnelEntryRef)
 
LE_SHARED uint32_t ifgen_taf_net_GetTunnelLocalId (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryRef_t tunnelEntryRef)
 
LE_SHARED uint32_t ifgen_taf_net_GetTunnelPeerId (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryRef_t tunnelEntryRef)
 
LE_SHARED uint32_t ifgen_taf_net_GetTunnelLocalUdpPort (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryRef_t tunnelEntryRef)
 
LE_SHARED uint32_t ifgen_taf_net_GetTunnelPeerUdpPort (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryRef_t tunnelEntryRef)
 
LE_SHARED le_result_t ifgen_taf_net_GetTunnelPeerIpv6Addr (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryRef_t tunnelEntryRef, char *peerIpv6Addr, size_t peerIpv6AddrSize)
 
LE_SHARED le_result_t ifgen_taf_net_GetTunnelPeerIpv4Addr (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryRef_t tunnelEntryRef, char *peerIpv4Addr, size_t peerIpv4AddrSize)
 
LE_SHARED le_result_t ifgen_taf_net_GetTunnelInterfaceName (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryRef_t tunnelEntryRef, char *ifName, size_t ifNameSize)
 
LE_SHARED taf_net_IpFamilyType_t ifgen_taf_net_GetTunnelIpType (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryRef_t tunnelEntryRef)
 
LE_SHARED le_result_t ifgen_taf_net_GetSessionConfig (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_TunnelEntryRef_t tunnelEntryRef, taf_net_L2tpSessionConfig_t *sessionConfigPtr, size_t *sessionConfigSizePtr)
 
LE_SHARED le_result_t ifgen_taf_net_EnableSocks (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED void ifgen_taf_net_EnableSocksAsync (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_AsyncSocksHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED le_result_t ifgen_taf_net_DisableSocks (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED void ifgen_taf_net_DisableSocksAsync (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_AsyncSocksHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED le_result_t ifgen_taf_net_SetSocksAuthMethod (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_AuthMethod_t authMethod)
 
LE_SHARED taf_net_AuthMethod_t ifgen_taf_net_GetSocksAuthMethod (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_net_SetSocksLanInterface (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL ifName)
 
LE_SHARED le_result_t ifgen_taf_net_GetSocksLanInterface (le_msg_SessionRef_t _ifgen_sessionRef, char *ifName, size_t ifNameSize)
 
LE_SHARED le_result_t ifgen_taf_net_AddSocksAssociation (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL userName, uint32_t profileId)
 
LE_SHARED le_result_t ifgen_taf_net_RemoveSocksAssociation (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL userName)
 
LE_SHARED le_result_t ifgen_taf_net_AddGsb (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL ifName, taf_net_GsbIfType_t ifType, uint32_t bandwidth)
 
LE_SHARED le_result_t ifgen_taf_net_RemoveGsb (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL ifName)
 
LE_SHARED le_result_t ifgen_taf_net_EnableGsb (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_net_DisableGsb (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED taf_net_GsbListRef_t ifgen_taf_net_GetGsbList (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED taf_net_GsbRef_t ifgen_taf_net_GetFirstGsb (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_GsbListRef_t gsbListRef)
 
LE_SHARED taf_net_GsbRef_t ifgen_taf_net_GetNextGsb (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_GsbListRef_t gsbListRef)
 
LE_SHARED le_result_t ifgen_taf_net_DeleteGsbList (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_GsbListRef_t gsbListRef)
 
LE_SHARED le_result_t ifgen_taf_net_GetGsbInterfaceName (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_GsbRef_t gsbRef, char *IfName, size_t IfNameSize)
 
LE_SHARED taf_net_GsbIfType_t ifgen_taf_net_GetGsbInterfaceType (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_GsbRef_t gsbRef)
 
LE_SHARED int32_t ifgen_taf_net_GetGsbBandWidth (le_msg_SessionRef_t _ifgen_sessionRef, taf_net_GsbRef_t gsbRef)
 

Macro Definition Documentation

◆ IFGEN_TAF_NET_PROTOCOL_ID

#define IFGEN_TAF_NET_PROTOCOL_ID   "4a13659273f4befc9ad9436efbdeba72"

◆ IFGEN_TAF_NET_MSG_SIZE

#define IFGEN_TAF_NET_MSG_SIZE   1384

◆ TAF_NET_INTERFACE_NAME_MAX_NUM

#define TAF_NET_INTERFACE_NAME_MAX_NUM   36

The interface name maximum number.

◆ TAF_NET_INTERFACE_NAME_MAX_LEN

#define TAF_NET_INTERFACE_NAME_MAX_LEN   30

The interface name maximum length.

◆ TAF_NET_IPV4_ADDR_MAX_LEN

#define TAF_NET_IPV4_ADDR_MAX_LEN   16

The IPv4 address maximum length.

◆ TAF_NET_IPV6_ADDR_MAX_LEN

#define TAF_NET_IPV6_ADDR_MAX_LEN   46

The IPv6 address maximum length.

◆ TAF_NET_IP_ADDR_MAX_LEN

#define TAF_NET_IP_ADDR_MAX_LEN   46

The IP address maximum length.

◆ TAF_NET_MAC_ADDR_MAX_LEN

#define TAF_NET_MAC_ADDR_MAX_LEN   17

MAC address maximum length.

◆ TAF_NET_MAX_NAT_ENTRY

#define TAF_NET_MAX_NAT_ENTRY   50

The maximum number of entries in the NAT memory pool.

◆ TAF_NET_MAX_VLAN_ENTRY

#define TAF_NET_MAX_VLAN_ENTRY   100

The maximum entry for VLAN memory pool.

◆ TAF_NET_MAX_VLAN_ENTRY_LIST

#define TAF_NET_MAX_VLAN_ENTRY_LIST   2

The maximum entry list for VLAN memory pool.

◆ TAF_NET_MAX_VLAN_INTERFACE

#define TAF_NET_MAX_VLAN_INTERFACE   5

The maximum interface for VLAN memory pool.

◆ TAF_NET_L2TP_MAX_TUNNEL_NUMBER

#define TAF_NET_L2TP_MAX_TUNNEL_NUMBER   2

The maximum tunnel number.

◆ TAF_NET_L2TP_MAX_SESSION_NUMBER_PER_TUNNEL

#define TAF_NET_L2TP_MAX_SESSION_NUMBER_PER_TUNNEL   3

The maximum session per tunnel.

◆ TAF_NET_SOCKSV5_MAX_USERNAME_LEN

#define TAF_NET_SOCKSV5_MAX_USERNAME_LEN   255

The maximum SOCKS username length.

◆ TAF_NET_SOCKSV5_MAX_MAPPING_POOL

#define TAF_NET_SOCKSV5_MAX_MAPPING_POOL   2

The maximum SOCKS mapping pool.

◆ TAF_NET_MAX_GSB_LIST_NUM

#define TAF_NET_MAX_GSB_LIST_NUM   2

The maximum list for GSB memory pool.

◆ TAF_NET_MAX_GSB_NUM

#define TAF_NET_MAX_GSB_NUM   10

The maximum number for GSB memory pool.

Typedef Documentation

◆ taf_net_DestNatEntryListRef_t

typedef struct taf_net_DestNatEntryList* taf_net_DestNatEntryListRef_t

Destination NAT entry list reference.

◆ taf_net_DestNatEntryRef_t

typedef struct taf_net_DestNatEntry* taf_net_DestNatEntryRef_t

◆ taf_net_VlanRef_t

typedef struct taf_net_Vlan* taf_net_VlanRef_t

VLAN reference.

◆ taf_net_VlanEntryListRef_t

typedef struct taf_net_VlanEntryList* taf_net_VlanEntryListRef_t

VLAN entry list reference.

◆ taf_net_VlanEntryRef_t

typedef struct taf_net_VlanEntry* taf_net_VlanEntryRef_t

VLAN entry reference.

◆ taf_net_VlanIfListRef_t

typedef struct taf_net_VlanIfList* taf_net_VlanIfListRef_t

VLAN interface list reference.

◆ taf_net_VlanIfRef_t

typedef struct taf_net_VlanIf* taf_net_VlanIfRef_t

VLAN interface reference.

◆ taf_net_TunnelEntryListRef_t

typedef struct taf_net_TunnelEntryList* taf_net_TunnelEntryListRef_t

Tunnel entry list reference.

◆ taf_net_TunnelEntryRef_t

typedef struct taf_net_TunnelEntry* taf_net_TunnelEntryRef_t

Tunnel entry reference.

◆ taf_net_TunnelRef_t

typedef struct taf_net_Tunnel* taf_net_TunnelRef_t

Tunnel reference.

◆ taf_net_GsbListRef_t

typedef struct taf_net_GsbList* taf_net_GsbListRef_t

The reference of a GSB list.

◆ taf_net_GsbRef_t

typedef struct taf_net_Gsb* taf_net_GsbRef_t

The reference of a GSB.

◆ taf_net_RouteChangeHandlerRef_t

typedef struct taf_net_RouteChangeHandler* taf_net_RouteChangeHandlerRef_t

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

◆ taf_net_GatewayChangeHandlerRef_t

typedef struct taf_net_GatewayChangeHandler* taf_net_GatewayChangeHandlerRef_t

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

◆ taf_net_DNSChangeHandlerRef_t

typedef struct taf_net_DNSChangeHandler* taf_net_DNSChangeHandlerRef_t

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

◆ taf_net_DestNatChangeHandlerRef_t

typedef struct taf_net_DestNatChangeHandler* taf_net_DestNatChangeHandlerRef_t

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

◆ taf_net_RouteChangeHandlerFunc_t

typedef void(* taf_net_RouteChangeHandlerFunc_t) (const taf_net_RouteChangeInd_t *LE_NONNULL routeIndPtr, void *contextPtr)

Handler for route changes.

◆ taf_net_GatewayChangeHandlerFunc_t

typedef void(* taf_net_GatewayChangeHandlerFunc_t) (const taf_net_GatewayChangeInd_t *LE_NONNULL gatewayIndPtr, void *contextPtr)

Handler for gateway changes.

◆ taf_net_DNSChangeHandlerFunc_t

typedef void(* taf_net_DNSChangeHandlerFunc_t) (const taf_net_DNSChangeInd_t *LE_NONNULL DNSIndPtr, void *contextPtr)

Handler for DNS changes.

◆ taf_net_DestNatChangeHandlerFunc_t

typedef void(* taf_net_DestNatChangeHandlerFunc_t) (const taf_net_DestNatChangeInd_t *LE_NONNULL destNatIndPtr, void *contextPtr)

Handler for destination NAT changes.

◆ taf_net_AsyncTunnelHandlerFunc_t

typedef void(* taf_net_AsyncTunnelHandlerFunc_t) (taf_net_TunnelRef_t tunnelRef, le_result_t result, void *contextPtr)

Handler for asynchronous starting or stopping tunnel result response.

◆ taf_net_AsyncL2tpHandlerFunc_t

typedef void(* taf_net_AsyncL2tpHandlerFunc_t) (le_result_t result, void *contextPtr)

Handler for asynchronous enabling or disabling L2TP result response.

◆ taf_net_AsyncSocksHandlerFunc_t

typedef void(* taf_net_AsyncSocksHandlerFunc_t) (le_result_t result, void *contextPtr)

Handler for asynchronous enabling or disabling SOCKS result response.

Enumeration Type Documentation

◆ taf_net_IpProto_t

IP protocol.

Enumerator
TAF_NET_TCP 

TCP.

TAF_NET_UDP 

UDP.

◆ taf_net_NetAction_t

Network action.

Enumerator
TAF_NET_DELETE 

Deletion operation.

TAF_NET_ADD 

Addition operation.

◆ taf_net_NetIpType_t

Network IP type.

Enumerator
TAF_NET_IPV4 

IPv4.

TAF_NET_IPV6 

IPv6.

◆ taf_net_TechType_t

The technology.

Enumerator
TAF_NET_TECH_CELLULAR 

Cellular.

TAF_NET_TECH_WIFI 

Wi-Fi.

TAF_NET_TECH_ETHERNET 

Ethernet.

◆ taf_net_State_t

The state.

Enumerator
TAF_NET_STATE_DOWN 

Down.

TAF_NET_STATE_UP 

Up.

◆ taf_net_L2tpEncapProtocol_t

L2TP encapsulation protocols.

Enumerator
TAF_NET_L2TP_NONE 
TAF_NET_L2TP_IP 
TAF_NET_L2TP_UDP 

◆ taf_net_IpFamilyType_t

Preferred IP family for the connection.

Enumerator
TAF_NET_L2TP_UNKNOWN 
TAF_NET_L2TP_IPV4 
TAF_NET_L2TP_IPV6 
TAF_NET_L2TP_IPV4V6 

◆ taf_net_VlanIfType_t

The VLAN interface type.

Enumerator
TAF_NET_IFACE_UNKNOWN 

Unknown interface.

TAF_NET_WLAN 

Wireless local area network (WLAN).

TAF_NET_ETH 

Ethernet (ETH).

TAF_NET_ECM 

Ethernet control model (ECM).

TAF_NET_RNDIS 

Remote network driver interface specification (RNDIS).

TAF_NET_MHI 

Modem host interface (MHI).

◆ taf_net_BindingAction_t

Binding action.

Enumerator
TAF_NET_BIND 

Bind.

TAF_NET_UNBIND 

Unbind.

◆ taf_net_DeviceMode_t

The device mode.

Enumerator
TAF_NET_DEVICE_UNKNOWN 

Unknown.

TAF_NET_DEVICE_NONE 

None.

TAF_NET_DEVICE_L2L 

Device LAN-to-LAN mode.

TAF_NET_DEVICE_E2E 

Device end-to-end mode.

◆ taf_net_AuthMethod_t

The SOCKS authentication type.

Enumerator
TAF_NET_SOCKS_UNKNOWN 

Unknown.

TAF_NET_SOCKS_NONE 

No authentication.

TAF_NET_SOCKS_USER_PASSWD 

Username and password.

◆ taf_net_GsbIfType_t

The GSB interface type.

Enumerator
TAF_NET_GSB_UNKNOWN 
TAF_NET_GSB_WLAN_AP 
TAF_NET_GSB_WLAN_STA 
TAF_NET_GSB_ETH 

Function Documentation

◆ ifgen_taf_net_HasLocalBinding()

LE_SHARED bool ifgen_taf_net_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_taf_net_InitCommonData()

LE_SHARED void ifgen_taf_net_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_taf_net_CleanupCommonData()

LE_SHARED void ifgen_taf_net_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_taf_net_OpenSession()

LE_SHARED le_result_t ifgen_taf_net_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_taf_net_AddRouteChangeHandler()

LE_SHARED taf_net_RouteChangeHandlerRef_t ifgen_taf_net_AddRouteChangeHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_RouteChangeHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_net_RouteChange'

Event to report route changes.

Parameters
[in]handlerPtrHandler for route changes.
[in]contextPtr

◆ ifgen_taf_net_RemoveRouteChangeHandler()

LE_SHARED void ifgen_taf_net_RemoveRouteChangeHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_RouteChangeHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_net_RouteChange'

Parameters
[in]handlerRef

◆ ifgen_taf_net_AddGatewayChangeHandler()

LE_SHARED taf_net_GatewayChangeHandlerRef_t ifgen_taf_net_AddGatewayChangeHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_GatewayChangeHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_net_GatewayChange'

Event to report gateway changes.

Parameters
[in]handlerPtrHandler for gateway changes.
[in]contextPtr

◆ ifgen_taf_net_RemoveGatewayChangeHandler()

LE_SHARED void ifgen_taf_net_RemoveGatewayChangeHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_GatewayChangeHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_net_GatewayChange'

Parameters
[in]handlerRef

◆ ifgen_taf_net_AddDNSChangeHandler()

LE_SHARED taf_net_DNSChangeHandlerRef_t ifgen_taf_net_AddDNSChangeHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_DNSChangeHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_net_DNSChange'

Event to report DNS changes.

Parameters
[in]handlerPtrHandler for DNS changes.
[in]contextPtr

◆ ifgen_taf_net_RemoveDNSChangeHandler()

LE_SHARED void ifgen_taf_net_RemoveDNSChangeHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_DNSChangeHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_net_DNSChange'

Parameters
[in]handlerRef

◆ ifgen_taf_net_AddDestNatChangeHandler()

LE_SHARED taf_net_DestNatChangeHandlerRef_t ifgen_taf_net_AddDestNatChangeHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_DestNatChangeHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_net_DestNatChange'

Event to report destination NAT change.

Parameters
[in]handlerPtrHandler for destination NAT changes.
[in]contextPtr

◆ ifgen_taf_net_RemoveDestNatChangeHandler()

LE_SHARED void ifgen_taf_net_RemoveDestNatChangeHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_DestNatChangeHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_net_DestNatChange'

Parameters
[in]handlerRef

◆ ifgen_taf_net_GetInterfaceList()

LE_SHARED le_result_t ifgen_taf_net_GetInterfaceList ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_InterfaceInfo_t ifInfoListPtr,
size_t *  ifInfoListSizePtr 
)

Gets the interface information list.

Returns
  • LE_OK – Succeeded.
  • LE_FAULT – Failed.
Parameters
[out]ifInfoListPtrInterface information list.
[in,out]ifInfoListSizePtr

◆ ifgen_taf_net_ChangeRoute()

LE_SHARED le_result_t ifgen_taf_net_ChangeRoute ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  interfaceName,
const char *LE_NONNULL  destAddr,
const char *LE_NONNULL  subnetMask,
uint16_t  metric,
taf_net_NetAction_t  isAdd 
)

Adds or removes a route.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]interfaceNameThe interface name.
[in]destAddrDestination IP address.
[in]subnetMaskDestination's subnet mask or length string.
[in]metricMetric.
[in]isAddAdd or delete.

◆ ifgen_taf_net_BackupDefaultGW()

LE_SHARED le_result_t ifgen_taf_net_BackupDefaultGW ( le_msg_SessionRef_t  _ifgen_sessionRef)

Backs up the current default gateway of the system into DB, including both IPv4 and IPv6.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – No default gateway.

◆ ifgen_taf_net_RestoreDefaultGW()

LE_SHARED le_result_t ifgen_taf_net_RestoreDefaultGW ( le_msg_SessionRef_t  _ifgen_sessionRef)

Restores the default gateway of the system from the last backed up one, including IPv4 and/or IPv6. Only gateways backed up and set by the same client session can be restored.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – No backup.
  • LE_FAULT – Failed.

◆ ifgen_taf_net_SetDefaultGW()

LE_SHARED le_result_t ifgen_taf_net_SetDefaultGW ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  ifName 
)

Sets the default gateway address received from the interface into the system.

Returns
  • LE_OK – Succeded.
  • LE_NOT_FOUND – No gateway address from the interface.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]ifNameThe interface from which to get the default gateway addresses.

◆ ifgen_taf_net_GetInterfaceGW()

LE_SHARED le_result_t ifgen_taf_net_GetInterfaceGW ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  ifName,
char *  ipv4Addr,
size_t  ipv4AddrSize,
char *  ipv6Addr,
size_t  ipv6AddrSize 
)

Gets the gateway addresses from the specified interface.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – No gateway address from the interface.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]ifNameInteraface name to get the gateway.
[out]ipv4AddrIPv4 address.
[in]ipv4AddrSize
[out]ipv6AddrIPv6 address.
[in]ipv6AddrSize

◆ ifgen_taf_net_SetDNS()

LE_SHARED le_result_t ifgen_taf_net_SetDNS ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  ifName 
)

Sets the DNS addresses received from the interface into the system.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – No DNS addresses from the interface.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]ifNameThe interface from which to get the DNS addresses.

◆ ifgen_taf_net_GetInterfaceDNS()

LE_SHARED le_result_t ifgen_taf_net_GetInterfaceDNS ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  ifName,
taf_net_DnsServerAddresses_t dnsServerAddressesPtr 
)

Gets the DNS addresses from the interface, including IPv4 and IPv6 addresses.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found DNS addresses from the interface.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]ifNameThe interface name from which to get the DNS addresses.
[out]dnsServerAddressesPtrDNS addresses structure.

◆ ifgen_taf_net_AddDestNatEntryOnDefaultPdn()

LE_SHARED le_result_t ifgen_taf_net_AddDestNatEntryOnDefaultPdn ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  privateIpAddr,
uint16_t  privatePort,
uint16_t  globalPort,
taf_net_IpProto_t  ipProto 
)

Adds a destination NAT entry on the default PDN.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]privateIpAddrPrivate IP address.
[in]privatePortPrivate port.
[in]globalPortGlobal port.
[in]ipProtoIP protocol number.

◆ ifgen_taf_net_RemoveDestNatEntryOnDefaultPdn()

LE_SHARED le_result_t ifgen_taf_net_RemoveDestNatEntryOnDefaultPdn ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  privateIpAddr,
uint16_t  privatePort,
uint16_t  globalPort,
taf_net_IpProto_t  ipProto 
)

Deletes a destination NAT entry on the default PDN.

Returns
  • LE_OK – Success
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failure.
Parameters
[in]privateIpAddrPrivate IP address.
[in]privatePortPrivate port.
[in]globalPortGlobal port.
[in]ipProtoIP protocol number.

◆ ifgen_taf_net_AddDestNatEntryOnDemandPdn()

LE_SHARED le_result_t ifgen_taf_net_AddDestNatEntryOnDemandPdn ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint32_t  profileId,
const char *LE_NONNULL  privateIpAddr,
uint16_t  privatePort,
uint16_t  globalPort,
taf_net_IpProto_t  ipProto 
)

Adds a destination NAT entry to the specified PDN.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]profileIdProfile ID.
[in]privateIpAddrPrivate IP address.
[in]privatePortPrivate port.
[in]globalPortGlobal port.
[in]ipProtoIP protocol number.

◆ ifgen_taf_net_RemoveDestNatEntryOnDemandPdn()

LE_SHARED le_result_t ifgen_taf_net_RemoveDestNatEntryOnDemandPdn ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint32_t  profileId,
const char *LE_NONNULL  privateIpAddr,
uint16_t  privatePort,
uint16_t  globalPort,
taf_net_IpProto_t  ipProto 
)

Deletes a destination NAT entry from the specified PDN.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]profileIdProfile ID.
[in]privateIpAddrPrivate IP address.
[in]privatePortPrivate port.
[in]globalPortGlobal port.
[in]ipProtoIP protocol number.

◆ ifgen_taf_net_GetDestNatEntryListOnDefaultPdn()

LE_SHARED taf_net_DestNatEntryListRef_t ifgen_taf_net_GetDestNatEntryListOnDefaultPdn ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets the reference to the destination NAT entry list on the default PDN.

Returns
  • NULL – If there was some other error.
  • Others – The reference to the destination NAT entry list.

◆ ifgen_taf_net_GetDestNatEntryListOnDemandPdn()

LE_SHARED taf_net_DestNatEntryListRef_t ifgen_taf_net_GetDestNatEntryListOnDemandPdn ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint32_t  profileId 
)

Gets the reference to the destination NAT entry list on the specified PDN.

Returns
  • NULL – If there was some other error.
  • Others – The reference to the destination NAT entry list.
Parameters
[in]profileIdThe profile ID.

◆ ifgen_taf_net_GetFirstDestNatEntry()

LE_SHARED taf_net_DestNatEntryRef_t ifgen_taf_net_GetFirstDestNatEntry ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_DestNatEntryListRef_t  destNatEntryListRef 
)

Gets the reference to the first destination NAT entry with a list reference.

Returns
  • NULL – Error.
  • Others – The reference to the first destination NAT entry.
Parameters
[in]destNatEntryListRefThe reference of a destination entry list.

◆ ifgen_taf_net_GetNextDestNatEntry()

LE_SHARED taf_net_DestNatEntryRef_t ifgen_taf_net_GetNextDestNatEntry ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_DestNatEntryListRef_t  destNatEntryListRef 
)

Gets the reference to the next destination NAT entry with a list reference.

Returns
  • NULL – Error.
  • Others – The reference of the next destination NAT entry.
Parameters
[in]destNatEntryListRefThe reference of a destination entry list.

◆ ifgen_taf_net_GetDestNatEntryDetails()

LE_SHARED le_result_t ifgen_taf_net_GetDestNatEntryDetails ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_DestNatEntryRef_t  destNatEntryRef,
char *  privateIpAddr,
size_t  privateIpAddrSize,
uint16_t *  privatePortPtr,
uint16_t *  globalPortPtr,
taf_net_IpProto_t ipProtoPtr 
)

Gets the information of a destination NAT entry with an entry reference.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]destNatEntryRefEntry reference.
[out]privateIpAddrPrivate IP address.
[in]privateIpAddrSize
[out]privatePortPtrPrivate port.
[out]globalPortPtrGlobal port.
[out]ipProtoPtrIP protocol number.

◆ ifgen_taf_net_DeleteDestNatEntryList()

LE_SHARED le_result_t ifgen_taf_net_DeleteDestNatEntryList ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_DestNatEntryListRef_t  destNatEntryListRef 
)

Deletes the reference to the destination NAT entry list.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]destNatEntryListRefThe reference of a destination entry list.

◆ ifgen_taf_net_CreateVlan()

LE_SHARED taf_net_VlanRef_t ifgen_taf_net_CreateVlan ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint16_t  vlanId,
bool  isAccelerated 
)

Creates a VLAN.

Note
To use VLAN bridge and VLAN binding features, set device mode with value 0 first.
Returns
  • NULL – Failure.
  • Others – The reference of VLAN.
Parameters
[in]vlanIdVLAN identifier, i.e., 1-4094.
[in]isAcceleratedIs acceleration allowed.

◆ ifgen_taf_net_SetVlanPriority()

LE_SHARED le_result_t ifgen_taf_net_SetVlanPriority ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanRef_t  vlanRef,
uint8_t  priority 
)

Sets the priority to a VLAN.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – VLAN was not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]vlanRefVLAN reference.
[in]priorityPriority.

◆ ifgen_taf_net_RemoveVlan()

LE_SHARED le_result_t ifgen_taf_net_RemoveVlan ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanRef_t  vlanRef 
)

Removes a VLAN.

Note
The system is not allowed to remove a VLAN if the VLAN interface list is not empty.
Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – VLAN was not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]vlanRefVLAN reference.

◆ ifgen_taf_net_GetVlanById()

LE_SHARED taf_net_VlanRef_t ifgen_taf_net_GetVlanById ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint16_t  vlanId 
)

Gets VLAN by the VLAN ID.

Returns
  • NULL – Not found.
  • Others – The VLAN reference.
Parameters
[in]vlanIdVLAN ID.

◆ ifgen_taf_net_AddVlanInterface()

LE_SHARED le_result_t ifgen_taf_net_AddVlanInterface ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanRef_t  vlanRef,
taf_net_VlanIfType_t  ifType 
)

Adds a VLAN interface into the VLAN interface list.

Note
Adding the first interface into the VLAN interface list with the same interface type triggers a system reboot if VLAN acceleration is enabled.
Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – VLAN was not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_DUPLICATE – ifType already added into the VLAN.
  • LE_FAULT – Failed.
Parameters
[in]vlanRefVLAN reference.
[in]ifTypeInterface type.

◆ ifgen_taf_net_RemoveVlanInterface()

LE_SHARED le_result_t ifgen_taf_net_RemoveVlanInterface ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanRef_t  vlanRef,
taf_net_VlanIfType_t  ifType 
)

Removes a VLAN interface from the VLAN interface list.

Note
Removing the last interface from the VLAN interface list with the same interface type triggers a system reboot if VLAN acceleration is enabled.
Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – VLAN was not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]vlanRefVLAN reference.
[in]ifTypeInterface type.

◆ ifgen_taf_net_GetVlanInterfaceList()

LE_SHARED taf_net_VlanIfListRef_t ifgen_taf_net_GetVlanInterfaceList ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanRef_t  vlanRef 
)

Gets the VLAN interface list.

Returns
  • NULL – If the VLAN was not found or the VLAN interface list is empty.
  • Others – The VLAN interface list reference.
Parameters
[in]vlanRefVLAN reference.

◆ ifgen_taf_net_GetFirstVlanInterface()

LE_SHARED taf_net_VlanIfRef_t ifgen_taf_net_GetFirstVlanInterface ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanIfListRef_t  vlanIfListRef 
)

Gets the first VLAN interface reference with a list.

Returns
  • NULL – The interface list doesn't exist.
  • Others – The first VLAN interface reference.
Parameters
[in]vlanIfListRefReference of a VLAN interface list.

◆ ifgen_taf_net_GetNextVlanInterface()

LE_SHARED taf_net_VlanIfRef_t ifgen_taf_net_GetNextVlanInterface ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanIfListRef_t  vlanIfListRef 
)

Gets the next VLAN interface reference with a list.

Returns
  • NULL – The VLAN interface list or the next interface doesn't exist.
  • Others – The next VLAN interface reference.
Parameters
[in]vlanIfListRefReference of a VLAN interface list.

◆ ifgen_taf_net_DeleteVlanInterfaceList()

LE_SHARED le_result_t ifgen_taf_net_DeleteVlanInterfaceList ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanIfListRef_t  vlanIfListRef 
)

Deletes the VLAN interface list.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – VLAN interface list was not found.
  • LE_BAD_PARAMETER – Bad parameter.
Parameters
[in]vlanIfListRefReference of a VLAN interface list.

◆ ifgen_taf_net_GetVlanInterfaceType()

LE_SHARED taf_net_VlanIfType_t ifgen_taf_net_GetVlanInterfaceType ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanIfRef_t  vlanIfRef 
)

Gets the interface type of a VLAN interface.

Returns
  • taf_net_VlanIfType_t – VLAN interface type.
  • TAF_NET_IFACE_UNKNOWN – VLAN interface was not found.
Parameters
[in]vlanIfRefVLAN interface reference.

◆ ifgen_taf_net_GetVlanPriority()

LE_SHARED le_result_t ifgen_taf_net_GetVlanPriority ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanIfRef_t  vlanIfRef,
uint8_t *  priorityPtr 
)

Gets the VLAN priority of a VLAN interface.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – VLAN was not found.
  • LE_BAD_PARAMETER – Bad parameter.
Parameters
[in]vlanIfRefVLAN interface reference.
[out]priorityPtrPriority.

◆ ifgen_taf_net_GetVlanEntryList()

LE_SHARED taf_net_VlanEntryListRef_t ifgen_taf_net_GetVlanEntryList ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets the VLAN entry list.

Returns
  • NULL – The VLAN entry list is empty.
  • Others – The VLAN entry list reference.

◆ ifgen_taf_net_GetFirstVlanEntry()

LE_SHARED taf_net_VlanEntryRef_t ifgen_taf_net_GetFirstVlanEntry ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanEntryListRef_t  vlanEntryListRef 
)

Gets the reference of the first VLAN entry with a list.

Returns
  • NULL – The VLAN entry list doesn't exist.
  • Others – The first VLAN entry reference.
Parameters
[in]vlanEntryListRefReference of a VLAN entry list.

◆ ifgen_taf_net_GetNextVlanEntry()

LE_SHARED taf_net_VlanEntryRef_t ifgen_taf_net_GetNextVlanEntry ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanEntryListRef_t  vlanEntryListRef 
)

Gets the reference of the next VLAN entry with a list.

Returns
  • NULL – The VLAN entry list or the next VLAN doesn't exist.
  • Others – The reference of the next VLAN entry.
Parameters
[in]vlanEntryListRefReference of a VLAN entry list.

◆ ifgen_taf_net_DeleteVlanEntryList()

LE_SHARED le_result_t ifgen_taf_net_DeleteVlanEntryList ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanEntryListRef_t  vlanEntryListRef 
)

Deletes the VLAN entry list.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Failed to delete the reference.
  • LE_BAD_PARAMETER – Bad parameter.
Parameters
[in]vlanEntryListRefReference of a VLAN entry list.

◆ ifgen_taf_net_GetVlanId()

LE_SHARED int16_t ifgen_taf_net_GetVlanId ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanEntryRef_t  vlanEntryRef 
)

Gets the VLAN ID by the VLAN entry reference.

Returns
  • 1-4094 – Succeeded.
  • others – Failed.
Parameters
[in]vlanEntryRefVLAN entry reference.

◆ ifgen_taf_net_IsVlanAccelerated()

LE_SHARED le_result_t ifgen_taf_net_IsVlanAccelerated ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanEntryRef_t  vlanEntryRef,
bool *  isAcceleratedPtr 
)

Determines if the VLAN is accelerated or not by the VLAN entry reference.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – VLAN was not found.
  • LE_BAD_PARAMETER – Bad parameter.
Parameters
[in]vlanEntryRefVLAN entry reference.
[out]isAcceleratedPtrIs accelerated or not.

◆ ifgen_taf_net_GetVlanBoundProfileId()

LE_SHARED int32_t ifgen_taf_net_GetVlanBoundProfileId ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanEntryRef_t  vlanEntryRef 
)

Gets the profile ID bound with a VLAN by the VLAN entry reference.

Returns
  • Others – Succeeded.
  • -1 – No binding.
Parameters
[in]vlanEntryRefVLAN entry reference.

◆ ifgen_taf_net_GetVlanBoundPhoneId()

LE_SHARED le_result_t ifgen_taf_net_GetVlanBoundPhoneId ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanEntryRef_t  vlanEntryRef,
uint8_t *  phoneIdPtr 
)

Gets the phone ID bound with a VLAN by the VLAN entry reference.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – VLAN was not found.
  • LE_BAD_PARAMETER – Bad parameter.
Parameters
[in]vlanEntryRefVLAN entry reference.
[out]phoneIdPtrPhone ID for VLAN association.

◆ ifgen_taf_net_BindVlanWithProfile()

LE_SHARED le_result_t ifgen_taf_net_BindVlanWithProfile ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanRef_t  vlanRef,
uint32_t  profileId 
)

Binds a VLAN with a specified profile ID.

Note
Binding VLAN with the default profile ID results in the system automatically rebooting after 5 seconds.
Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – VLAN wass not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]vlanRefVLAN reference.
[in]profileIdProfile ID for VLAN association.

◆ ifgen_taf_net_BindVlanWithProfileEx()

LE_SHARED le_result_t ifgen_taf_net_BindVlanWithProfileEx ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanRef_t  vlanRef,
uint8_t  phoneId,
uint32_t  profileId 
)

Binds a VLAN with a specified phone ID and profile index.

Note
Binding a VLAN with the default profile ID results in the system automatically rebooting after 5 seconds.
Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – VLAN wass not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]vlanRefVLAN reference.
[in]phoneIdPhone for VLAN association.
[in]profileIdProfile ID for VLAN association.

◆ ifgen_taf_net_UnbindVlanFromProfile()

LE_SHARED le_result_t ifgen_taf_net_UnbindVlanFromProfile ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_VlanRef_t  vlanRef 
)

Unbinds a VLAN from previous profile ID.

Note
Unbinding VLAN from the default profile ID results in the system automatically rebooting after 5 seconds.
Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – VLAN wass not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]vlanRefVLAN reference.

◆ ifgen_taf_net_EnableL2tp()

LE_SHARED le_result_t ifgen_taf_net_EnableL2tp ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  enableMss,
bool  enableMtu,
uint32_t  mtuSize 
)

Enables (synchronously) L2TP for unmanaged tunnel state.

Note
To use the L2TP feature set device mode with value 1 first.
Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_FAULT – Failed.
Parameters
[in]enableMssEnable TCP MSS to be clamped on L2TP interfaces.
[in]enableMtuEnable MTU size to be set on underlying interfaces.
[in]mtuSizeOptional MTU size in bytes; default is 1422.

◆ ifgen_taf_net_EnableL2tpAsync()

LE_SHARED void ifgen_taf_net_EnableL2tpAsync ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  enableMss,
bool  enableMtu,
uint32_t  mtuSize,
taf_net_AsyncL2tpHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Enables (asynchronously) L2TP for unmanaged tunnel state.

Parameters
[in]enableMssEnable TCP MSS to be clamped on L2TP interfaces.
[in]enableMtuEnable MTU size to be set on underlying interfaces.
[in]mtuSizeoptional MTU size in bytes; default is 1422.
[in]handlerPtrThe handler.
[in]contextPtr

◆ ifgen_taf_net_DisableL2tp()

LE_SHARED le_result_t ifgen_taf_net_DisableL2tp ( le_msg_SessionRef_t  _ifgen_sessionRef)

Disables (synchronously) L2TP for unmanaged tunnel state.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_FAULT – Failed.

◆ ifgen_taf_net_DisableL2tpAsync()

LE_SHARED void ifgen_taf_net_DisableL2tpAsync ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_AsyncL2tpHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Disables (asynchronously) L2TP for unmanaged tunnel state.

Returns
None.
Parameters
[in]handlerPtrThe handler.
[in]contextPtr

◆ ifgen_taf_net_IsL2tpEnabled()

LE_SHARED bool ifgen_taf_net_IsL2tpEnabled ( le_msg_SessionRef_t  _ifgen_sessionRef)

Determines if L2TP is enabled.

Returns
  • false – L2TP is disabled.
  • true – L2TP is enabled.

◆ ifgen_taf_net_IsL2tpMssEnabled()

LE_SHARED bool ifgen_taf_net_IsL2tpMssEnabled ( le_msg_SessionRef_t  _ifgen_sessionRef)

Determines if maximum segment size (MSS) is enabled.

Returns
  • false – MSS is disabled for L2TP.
  • true – MSS is enabled for L2TP.

◆ ifgen_taf_net_IsL2tpMtuEnabled()

LE_SHARED bool ifgen_taf_net_IsL2tpMtuEnabled ( le_msg_SessionRef_t  _ifgen_sessionRef)

Determines if maximum transmission unit (MTU) is enabled.

Returns
  • false – MTU is disabled for L2TP.
  • true – MTU is enabled for L2TP.

◆ ifgen_taf_net_GetL2tpMtuSize()

LE_SHARED uint32_t ifgen_taf_net_GetL2tpMtuSize ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets L2TP MTU size.

Returns
  • 0 – Failed.
  • Others – Succeeded.

◆ ifgen_taf_net_CreateTunnel()

LE_SHARED taf_net_TunnelRef_t ifgen_taf_net_CreateTunnel ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_L2tpEncapProtocol_t  encaProto,
uint32_t  locId,
uint32_t  peerId,
const char *LE_NONNULL  peerIpAddr,
const char *LE_NONNULL  ifName 
)

Creates an L2TP tunnel.

Returns
  • NULL – Failed.
  • Others – The tunnel reference.
Parameters
[in]encaProtoEncapsulation protocol, UDP or IP.
[in]locIdLocal tunnel ID.
[in]peerIdPeer tunnel ID.
[in]peerIpAddrPeer IP address.
[in]ifNameInterface name.

◆ ifgen_taf_net_RemoveTunnel()

LE_SHARED le_result_t ifgen_taf_net_RemoveTunnel ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelRef_t  tunnelRef 
)

Removes an L2TP tunnel.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]tunnelRefTunnel reference.

◆ ifgen_taf_net_SetTunnelUdpPort()

LE_SHARED le_result_t ifgen_taf_net_SetTunnelUdpPort ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelRef_t  tunnelRef,
uint32_t  localUdpPort,
uint32_t  peerUdpPort 
)

Sets UDP ports for a tunnel.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]tunnelRefTunnel reference.
[in]localUdpPortLocal UDP port, if UDP encapsulation is used.
[in]peerUdpPortPeer UDP port, if IP encapsulation is used.

◆ ifgen_taf_net_AddSession()

LE_SHARED le_result_t ifgen_taf_net_AddSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelRef_t  tunnelRef,
uint32_t  locId,
uint32_t  peerId 
)

Adds a session into a tunnel.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]tunnelRefTunnel reference.
[in]locIdLocal session ID.
[in]peerIdPeer session ID.

◆ ifgen_taf_net_RemoveSession()

LE_SHARED le_result_t ifgen_taf_net_RemoveSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelRef_t  tunnelRef,
uint32_t  locId,
uint32_t  peerId 
)

Removes a session from a tunnel.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]tunnelRefTunnel reference.
[in]locIdLocal session ID.
[in]peerIdPeer session ID.

◆ ifgen_taf_net_StartTunnel()

LE_SHARED le_result_t ifgen_taf_net_StartTunnel ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelRef_t  tunnelRef 
)

Starts (synchronously) a tunnel.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]tunnelRefTunnel reference.

◆ ifgen_taf_net_StartTunnelAsync()

LE_SHARED void ifgen_taf_net_StartTunnelAsync ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelRef_t  tunnelRef,
taf_net_AsyncTunnelHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Starts (asynchronously) a tunnel.

Parameters
[in]tunnelRefTunnel reference.
[in]handlerPtrThe handler.
[in]contextPtr

◆ ifgen_taf_net_StopTunnel()

LE_SHARED le_result_t ifgen_taf_net_StopTunnel ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelRef_t  tunnelRef 
)

Stops (synchronously) a tunnel.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]tunnelRefTunnel reference.

◆ ifgen_taf_net_StopTunnelAsync()

LE_SHARED void ifgen_taf_net_StopTunnelAsync ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelRef_t  tunnelRef,
taf_net_AsyncTunnelHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Stops (asynchronously) a tunnel.

Returns
None.
Parameters
[in]tunnelRefTunnel reference.
[in]handlerPtrThe handler.
[in]contextPtr

◆ ifgen_taf_net_GetTunnelRefById()

LE_SHARED taf_net_TunnelRef_t ifgen_taf_net_GetTunnelRefById ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint32_t  locId 
)

Gets tunnel reference by the local tunnel ID.

Returns
  • NULL – Failed.
  • Others – The created tunnel reference.
Parameters
[in]locIdLocal tunnel ID.

◆ ifgen_taf_net_GetTunnelEntryList()

LE_SHARED taf_net_TunnelEntryListRef_t ifgen_taf_net_GetTunnelEntryList ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets the tunnel entry list.

Returns
  • NULL – Failed.
  • Others – The tunnel entry list reference.

◆ ifgen_taf_net_GetFirstTunnelEntry()

LE_SHARED taf_net_TunnelEntryRef_t ifgen_taf_net_GetFirstTunnelEntry ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryListRef_t  tunnelEntryListRef 
)

Gets the reference of the first tunnel entry.

Returns
  • NULL – Failed.
  • Others – The first tunnel entry reference.
Parameters
[in]tunnelEntryListRefReference of a tunnel entry list.

◆ ifgen_taf_net_GetNextTunnelEntry()

LE_SHARED taf_net_TunnelEntryRef_t ifgen_taf_net_GetNextTunnelEntry ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryListRef_t  tunnelEntryListRef 
)

Gets the reference of the next tunnel entry.

Returns
  • NULL – Failed.
  • Others – The next tunnel entry reference.
Parameters
[in]tunnelEntryListRefReference of a tunnel entry list.

◆ ifgen_taf_net_DeleteTunnelEntryList()

LE_SHARED le_result_t ifgen_taf_net_DeleteTunnelEntryList ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryListRef_t  tunnelEntryListRef 
)

Deletes a tunnel entry list.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]tunnelEntryListRefReference of a tunnel entry list.

◆ ifgen_taf_net_GetTunnelEncapProto()

LE_SHARED taf_net_L2tpEncapProtocol_t ifgen_taf_net_GetTunnelEncapProto ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryRef_t  tunnelEntryRef 
)

Gets the encapsulation protocol of a tunnel.

Returns
  • TAF_NET_L2TP_NONE – Failed.
  • TAF_NET_L2TP_IP – IP protocol used for encapsulation.
  • TAF_NET_L2TP_UDP – UDP protocol used for encapsulation.
Parameters
[in]tunnelEntryRefTunnel entry reference.

◆ ifgen_taf_net_GetTunnelLocalId()

LE_SHARED uint32_t ifgen_taf_net_GetTunnelLocalId ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryRef_t  tunnelEntryRef 
)

Gets the local ID of a tunnel.

Returns
  • 0 – Failed.
  • Others – Succeeded.
Parameters
[in]tunnelEntryRefTunnel entry reference.

◆ ifgen_taf_net_GetTunnelPeerId()

LE_SHARED uint32_t ifgen_taf_net_GetTunnelPeerId ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryRef_t  tunnelEntryRef 
)

Gets the peer ID of a tunnel.

Returns
  • 0 – Failed.
  • Others – Succeeded.
Parameters
[in]tunnelEntryRefTunnel entry reference.

◆ ifgen_taf_net_GetTunnelLocalUdpPort()

LE_SHARED uint32_t ifgen_taf_net_GetTunnelLocalUdpPort ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryRef_t  tunnelEntryRef 
)

Gets the local UDP port of a tunnel.

Returns
  • 0 – Failed.
  • Others – Succeeded.
Parameters
[in]tunnelEntryRefTunnel entry reference.

◆ ifgen_taf_net_GetTunnelPeerUdpPort()

LE_SHARED uint32_t ifgen_taf_net_GetTunnelPeerUdpPort ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryRef_t  tunnelEntryRef 
)

Gets the peer UDP port of a tunnel.

Returns
  • 0 – Failed.
  • Others – Succeeded.
Parameters
[in]tunnelEntryRefTunnel entry reference.

◆ ifgen_taf_net_GetTunnelPeerIpv6Addr()

LE_SHARED le_result_t ifgen_taf_net_GetTunnelPeerIpv6Addr ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryRef_t  tunnelEntryRef,
char *  peerIpv6Addr,
size_t  peerIpv6AddrSize 
)

Gets the peer IPv6 address of a tunnel.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]tunnelEntryRefTunnel entry reference.
[out]peerIpv6AddrPeer IPv6 address.
[in]peerIpv6AddrSize

◆ ifgen_taf_net_GetTunnelPeerIpv4Addr()

LE_SHARED le_result_t ifgen_taf_net_GetTunnelPeerIpv4Addr ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryRef_t  tunnelEntryRef,
char *  peerIpv4Addr,
size_t  peerIpv4AddrSize 
)

Gets the peer IPv4 address of a tunnel.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]tunnelEntryRefTunnel entry reference.
[out]peerIpv4AddrPeer IPv4 address.
[in]peerIpv4AddrSize

◆ ifgen_taf_net_GetTunnelInterfaceName()

LE_SHARED le_result_t ifgen_taf_net_GetTunnelInterfaceName ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryRef_t  tunnelEntryRef,
char *  ifName,
size_t  ifNameSize 
)

Gets the interface name of a tunnel.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
Parameters
[in]tunnelEntryRefTunnel entry reference.
[out]ifNameInterface name.
[in]ifNameSize

◆ ifgen_taf_net_GetTunnelIpType()

LE_SHARED taf_net_IpFamilyType_t ifgen_taf_net_GetTunnelIpType ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryRef_t  tunnelEntryRef 
)

Gets the IP type of a tunnel.

  • TAF_NET_L2TP_UNKNOWN – Failed.
  • TAF_NET_L2TP_IPV4 – IPv4.
  • TAF_NET_L2TP_IPV6 – IPv6.
Parameters
[in]tunnelEntryRefTunnel entry reference.

◆ ifgen_taf_net_GetSessionConfig()

LE_SHARED le_result_t ifgen_taf_net_GetSessionConfig ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_TunnelEntryRef_t  tunnelEntryRef,
taf_net_L2tpSessionConfig_t sessionConfigPtr,
size_t *  sessionConfigSizePtr 
)

Gets the session configuration of a tunnel.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]tunnelEntryRefTunnel entry reference.
[out]sessionConfigPtrSession configuration.
[in,out]sessionConfigSizePtr

◆ ifgen_taf_net_EnableSocks()

LE_SHARED le_result_t ifgen_taf_net_EnableSocks ( le_msg_SessionRef_t  _ifgen_sessionRef)

Enables (synchronously) the SOCKS proxy service.

Note
To use the SOCKS feature, set device mode with value 2 first.
Returns
  • LE_OK – Succeeded.
  • LE_FAULT – Failed.

◆ ifgen_taf_net_EnableSocksAsync()

LE_SHARED void ifgen_taf_net_EnableSocksAsync ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_AsyncSocksHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Enables (asynchronously) the SOCKS proxy service.

Returns
None.
Parameters
[in]handlerPtrThe handler.
[in]contextPtr

◆ ifgen_taf_net_DisableSocks()

LE_SHARED le_result_t ifgen_taf_net_DisableSocks ( le_msg_SessionRef_t  _ifgen_sessionRef)

Disables (synchronously) the SOCKS proxy service.

Returns
  • LE_OK – Succeeded.
  • LE_FAULT – Failed.

◆ ifgen_taf_net_DisableSocksAsync()

LE_SHARED void ifgen_taf_net_DisableSocksAsync ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_AsyncSocksHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Disables (asynchronously) the SOCKS proxy service.

Returns
None.
Parameters
[in]handlerPtrThe handler.
[in]contextPtr

◆ ifgen_taf_net_SetSocksAuthMethod()

LE_SHARED le_result_t ifgen_taf_net_SetSocksAuthMethod ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_AuthMethod_t  authMethod 
)

Sets the SOCKS authentication method.

Returns
  • LE_OK – Succeeded.
  • LE_FAULT – Failed.
Parameters
[in]authMethodAuthentication method.

◆ ifgen_taf_net_GetSocksAuthMethod()

LE_SHARED taf_net_AuthMethod_t ifgen_taf_net_GetSocksAuthMethod ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets the SOCKS authentication method.

Returns
  • TAF_NET_SOCKS_UNKNOWN – Unknown.
  • TAF_NET_SOCKS_NONE – No authentication.
  • TAF_NET_SOCKS_USER_PASSWD – Username and password.

◆ ifgen_taf_net_SetSocksLanInterface()

LE_SHARED le_result_t ifgen_taf_net_SetSocksLanInterface ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  ifName 
)

Sets SOCKS LAN interface.

Returns
  • LE_OK – Succeeded.
  • LE_FAULT – Failed.
Parameters
[in]ifNameInterface name.

◆ ifgen_taf_net_GetSocksLanInterface()

LE_SHARED le_result_t ifgen_taf_net_GetSocksLanInterface ( le_msg_SessionRef_t  _ifgen_sessionRef,
char *  ifName,
size_t  ifNameSize 
)

Gets SOCKS LAN interface.

Returns
  • LE_OK – Succeeded.
  • LE_FAULT – Failed.
Parameters
[out]ifNameInterface name.
[in]ifNameSize

◆ ifgen_taf_net_AddSocksAssociation()

LE_SHARED le_result_t ifgen_taf_net_AddSocksAssociation ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  userName,
uint32_t  profileId 
)

Adds a username/profile association.

Returns
  • LE_OK – Succeeded.
  • LE_FAULT – Failed.
Parameters
[in]userNameUsername.
[in]profileIdProfile ID.

◆ ifgen_taf_net_RemoveSocksAssociation()

LE_SHARED le_result_t ifgen_taf_net_RemoveSocksAssociation ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  userName 
)

Deletes a username/profile association.

Returns
  • LE_OK – Succeeded.
  • LE_FAULT – Failed.
Parameters
[in]userNameUsername.

◆ ifgen_taf_net_AddGsb()

LE_SHARED le_result_t ifgen_taf_net_AddGsb ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  ifName,
taf_net_GsbIfType_t  ifType,
uint32_t  bandwidth 
)

Adds GSB configuration for an interface.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]ifNameInterface name.
[in]ifTypeInterface type.
[in]bandwidthBandwidth (in Mbps).

◆ ifgen_taf_net_RemoveGsb()

LE_SHARED le_result_t ifgen_taf_net_RemoveGsb ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  ifName 
)

Removes GSB configuration for an interface.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]ifNameInterface name.

◆ ifgen_taf_net_EnableGsb()

LE_SHARED le_result_t ifgen_taf_net_EnableGsb ( le_msg_SessionRef_t  _ifgen_sessionRef)

Enables GSB in the system.

Returns
  • LE_OK – Succeeded.
  • LE_FAULT – Failed.

◆ ifgen_taf_net_DisableGsb()

LE_SHARED le_result_t ifgen_taf_net_DisableGsb ( le_msg_SessionRef_t  _ifgen_sessionRef)

Disables GSB in the system.

Returns
  • LE_OK – Succeeded.
  • LE_FAULT – Failed.

◆ ifgen_taf_net_GetGsbList()

LE_SHARED taf_net_GsbListRef_t ifgen_taf_net_GetGsbList ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets GSB list.

Returns
  • NULL – Failed.
  • Others – The GSB list reference.

◆ ifgen_taf_net_GetFirstGsb()

LE_SHARED taf_net_GsbRef_t ifgen_taf_net_GetFirstGsb ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_GsbListRef_t  gsbListRef 
)

Gets the reference of the first GSB.

Returns
  • NULL – Failed.
  • Others – The first GSB reference.
Parameters
[in]gsbListRefReference of a GSB list.

◆ ifgen_taf_net_GetNextGsb()

LE_SHARED taf_net_GsbRef_t ifgen_taf_net_GetNextGsb ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_GsbListRef_t  gsbListRef 
)

Gets the reference of the next GSB.

Returns
  • NULL – Failed.
  • Others – The next GSB reference.
Parameters
[in]gsbListRefReference of a GSB list.

◆ ifgen_taf_net_DeleteGsbList()

LE_SHARED le_result_t ifgen_taf_net_DeleteGsbList ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_GsbListRef_t  gsbListRef 
)

Deletes the GSB list.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]gsbListRefReference of a GSB list.

◆ ifgen_taf_net_GetGsbInterfaceName()

LE_SHARED le_result_t ifgen_taf_net_GetGsbInterfaceName ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_GsbRef_t  gsbRef,
char *  IfName,
size_t  IfNameSize 
)

Gets the interface name of a GSB.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Not found.
  • LE_BAD_PARAMETER – Bad parameter.
  • LE_FAULT – Failed.
Parameters
[in]gsbRefGSB reference.
[out]IfNameInterface name.
[in]IfNameSize

◆ ifgen_taf_net_GetGsbInterfaceType()

LE_SHARED taf_net_GsbIfType_t ifgen_taf_net_GetGsbInterfaceType ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_GsbRef_t  gsbRef 
)

Gets the interface type of a GSB.

Returns
  • GSB_UNKNOWN – Unknown type.
  • GSB_WLAN_AP – WLAN AP.
  • GSB_WLAN_STA – WLAN station.
  • GSB_ETH – Ethernet.
Parameters
[in]gsbRefGSB reference.

◆ ifgen_taf_net_GetGsbBandWidth()

LE_SHARED int32_t ifgen_taf_net_GetGsbBandWidth ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_net_GsbRef_t  gsbRef 
)

Gets the bandwidth of a GSB.

Returns
  • -1 – Failed.
  • Others – Succeeded.
Parameters
[in]gsbRefGSB reference.