Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
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) |
#define IFGEN_TAF_NET_PROTOCOL_ID "4a13659273f4befc9ad9436efbdeba72" |
#define IFGEN_TAF_NET_MSG_SIZE 1384 |
#define TAF_NET_INTERFACE_NAME_MAX_NUM 36 |
The interface name maximum number.
#define TAF_NET_INTERFACE_NAME_MAX_LEN 30 |
The interface name maximum length.
#define TAF_NET_IPV4_ADDR_MAX_LEN 16 |
The IPv4 address maximum length.
#define TAF_NET_IPV6_ADDR_MAX_LEN 46 |
The IPv6 address maximum length.
#define TAF_NET_IP_ADDR_MAX_LEN 46 |
The IP address maximum length.
#define TAF_NET_MAC_ADDR_MAX_LEN 17 |
MAC address maximum length.
#define TAF_NET_MAX_NAT_ENTRY 50 |
The maximum number of entries in the NAT memory pool.
#define TAF_NET_MAX_VLAN_ENTRY 100 |
The maximum entry for VLAN memory pool.
#define TAF_NET_MAX_VLAN_ENTRY_LIST 2 |
The maximum entry list for VLAN memory pool.
#define TAF_NET_MAX_VLAN_INTERFACE 5 |
The maximum interface for VLAN memory pool.
#define TAF_NET_L2TP_MAX_TUNNEL_NUMBER 2 |
The maximum tunnel number.
#define TAF_NET_L2TP_MAX_SESSION_NUMBER_PER_TUNNEL 3 |
The maximum session per tunnel.
#define TAF_NET_SOCKSV5_MAX_USERNAME_LEN 255 |
The maximum SOCKS username length.
#define TAF_NET_SOCKSV5_MAX_MAPPING_POOL 2 |
The maximum SOCKS mapping pool.
#define TAF_NET_MAX_GSB_LIST_NUM 2 |
The maximum list for GSB memory pool.
#define TAF_NET_MAX_GSB_NUM 10 |
The maximum number for GSB memory pool.
typedef struct taf_net_DestNatEntryList* taf_net_DestNatEntryListRef_t |
Destination NAT entry list reference.
typedef struct taf_net_DestNatEntry* taf_net_DestNatEntryRef_t |
typedef struct taf_net_Vlan* taf_net_VlanRef_t |
VLAN reference.
typedef struct taf_net_VlanEntryList* taf_net_VlanEntryListRef_t |
VLAN entry list reference.
typedef struct taf_net_VlanEntry* taf_net_VlanEntryRef_t |
VLAN entry reference.
typedef struct taf_net_VlanIfList* taf_net_VlanIfListRef_t |
VLAN interface list reference.
typedef struct taf_net_VlanIf* taf_net_VlanIfRef_t |
VLAN interface reference.
typedef struct taf_net_TunnelEntryList* taf_net_TunnelEntryListRef_t |
Tunnel entry list reference.
typedef struct taf_net_TunnelEntry* taf_net_TunnelEntryRef_t |
Tunnel entry reference.
typedef struct taf_net_Tunnel* taf_net_TunnelRef_t |
Tunnel reference.
typedef struct taf_net_GsbList* taf_net_GsbListRef_t |
The reference of a GSB list.
typedef struct taf_net_Gsb* taf_net_GsbRef_t |
The reference of a GSB.
typedef struct taf_net_RouteChangeHandler* taf_net_RouteChangeHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'taf_net_RouteChange'
typedef struct taf_net_GatewayChangeHandler* taf_net_GatewayChangeHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'taf_net_GatewayChange'
typedef struct taf_net_DNSChangeHandler* taf_net_DNSChangeHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'taf_net_DNSChange'
typedef struct taf_net_DestNatChangeHandler* taf_net_DestNatChangeHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'taf_net_DestNatChange'
typedef void(* taf_net_RouteChangeHandlerFunc_t) (const taf_net_RouteChangeInd_t *LE_NONNULL routeIndPtr, void *contextPtr) |
Handler for route changes.
typedef void(* taf_net_GatewayChangeHandlerFunc_t) (const taf_net_GatewayChangeInd_t *LE_NONNULL gatewayIndPtr, void *contextPtr) |
Handler for gateway changes.
typedef void(* taf_net_DNSChangeHandlerFunc_t) (const taf_net_DNSChangeInd_t *LE_NONNULL DNSIndPtr, void *contextPtr) |
Handler for DNS changes.
typedef void(* taf_net_DestNatChangeHandlerFunc_t) (const taf_net_DestNatChangeInd_t *LE_NONNULL destNatIndPtr, void *contextPtr) |
Handler for destination NAT changes.
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.
typedef void(* taf_net_AsyncL2tpHandlerFunc_t) (le_result_t result, void *contextPtr) |
Handler for asynchronous enabling or disabling L2TP result response.
typedef void(* taf_net_AsyncSocksHandlerFunc_t) (le_result_t result, void *contextPtr) |
Handler for asynchronous enabling or disabling SOCKS result response.
enum taf_net_IpProto_t |
enum taf_net_NetAction_t |
enum taf_net_NetIpType_t |
enum taf_net_TechType_t |
enum taf_net_State_t |
enum taf_net_VlanIfType_t |
The VLAN interface type.
enum taf_net_DeviceMode_t |
enum taf_net_AuthMethod_t |
enum taf_net_GsbIfType_t |
LE_SHARED bool ifgen_taf_net_HasLocalBinding | ( | void | ) |
Get if this client bound locally.
LE_SHARED void ifgen_taf_net_InitCommonData | ( | void | ) |
Init data that is common across all threads
LE_SHARED void ifgen_taf_net_CleanupCommonData | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Cleanup the data of a session
LE_SHARED le_result_t ifgen_taf_net_OpenSession | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
bool | isBlocking | ||
) |
Perform common initialization and open a session
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.
[in] | handlerPtr | Handler for route changes. |
[in] | contextPtr |
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'
[in] | handlerRef |
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.
[in] | handlerPtr | Handler for gateway changes. |
[in] | contextPtr |
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'
[in] | handlerRef |
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.
[in] | handlerPtr | Handler for DNS changes. |
[in] | contextPtr |
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'
[in] | handlerRef |
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.
[in] | handlerPtr | Handler for destination NAT changes. |
[in] | contextPtr |
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'
[in] | handlerRef |
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.
[out] | ifInfoListPtr | Interface information list. |
[in,out] | 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 | ||
) |
Adds or removes a route.
[in] | interfaceName | The interface name. |
[in] | destAddr | Destination IP address. |
[in] | subnetMask | Destination's subnet mask or length string. |
[in] | metric | Metric. |
[in] | isAdd | Add or delete. |
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.
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.
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.
[in] | ifName | The interface from which to get the default gateway addresses. |
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.
[in] | ifName | Interaface name to get the gateway. |
[out] | ipv4Addr | IPv4 address. |
[in] | ipv4AddrSize | |
[out] | ipv6Addr | IPv6 address. |
[in] | ipv6AddrSize |
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.
[in] | ifName | The interface from which to get the DNS addresses. |
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.
[in] | ifName | The interface name from which to get the DNS addresses. |
[out] | dnsServerAddressesPtr | DNS addresses structure. |
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.
[in] | privateIpAddr | Private IP address. |
[in] | privatePort | Private port. |
[in] | globalPort | Global port. |
[in] | ipProto | IP protocol number. |
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.
[in] | privateIpAddr | Private IP address. |
[in] | privatePort | Private port. |
[in] | globalPort | Global port. |
[in] | ipProto | IP protocol number. |
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.
[in] | profileId | Profile ID. |
[in] | privateIpAddr | Private IP address. |
[in] | privatePort | Private port. |
[in] | globalPort | Global port. |
[in] | ipProto | IP protocol number. |
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.
[in] | profileId | Profile ID. |
[in] | privateIpAddr | Private IP address. |
[in] | privatePort | Private port. |
[in] | globalPort | Global port. |
[in] | ipProto | IP protocol number. |
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.
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.
[in] | profileId | The profile ID. |
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.
[in] | destNatEntryListRef | The reference of a destination entry list. |
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.
[in] | destNatEntryListRef | The reference of a destination entry list. |
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.
[in] | destNatEntryRef | Entry reference. |
[out] | privateIpAddr | Private IP address. |
[in] | privateIpAddrSize | |
[out] | privatePortPtr | Private port. |
[out] | globalPortPtr | Global port. |
[out] | ipProtoPtr | IP protocol number. |
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.
[in] | destNatEntryListRef | The reference of a destination entry list. |
LE_SHARED taf_net_VlanRef_t ifgen_taf_net_CreateVlan | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
uint16_t | vlanId, | ||
bool | isAccelerated | ||
) |
Creates a VLAN.
[in] | vlanId | VLAN identifier, i.e., 1-4094. |
[in] | isAccelerated | Is acceleration allowed. |
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.
[in] | vlanRef | VLAN reference. |
[in] | priority | Priority. |
LE_SHARED le_result_t ifgen_taf_net_RemoveVlan | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_net_VlanRef_t | vlanRef | ||
) |
Removes a VLAN.
[in] | vlanRef | VLAN reference. |
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.
[in] | vlanId | VLAN ID. |
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.
[in] | vlanRef | VLAN reference. |
[in] | ifType | Interface type. |
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.
[in] | vlanRef | VLAN reference. |
[in] | ifType | Interface type. |
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.
[in] | vlanRef | VLAN reference. |
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.
[in] | vlanIfListRef | Reference of a VLAN interface list. |
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.
[in] | vlanIfListRef | Reference of a VLAN interface list. |
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.
[in] | vlanIfListRef | Reference of a VLAN interface list. |
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.
[in] | vlanIfRef | VLAN interface reference. |
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.
[in] | vlanIfRef | VLAN interface reference. |
[out] | priorityPtr | Priority. |
LE_SHARED taf_net_VlanEntryListRef_t ifgen_taf_net_GetVlanEntryList | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Gets the VLAN entry list.
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.
[in] | vlanEntryListRef | Reference of a VLAN entry list. |
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.
[in] | vlanEntryListRef | Reference of a VLAN entry list. |
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.
[in] | vlanEntryListRef | Reference of a VLAN entry list. |
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.
[in] | vlanEntryRef | VLAN entry reference. |
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.
[in] | vlanEntryRef | VLAN entry reference. |
[out] | isAcceleratedPtr | Is accelerated or not. |
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.
[in] | vlanEntryRef | VLAN entry reference. |
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.
[in] | vlanEntryRef | VLAN entry reference. |
[out] | phoneIdPtr | Phone ID for VLAN association. |
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.
[in] | vlanRef | VLAN reference. |
[in] | profileId | Profile ID for VLAN association. |
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.
[in] | vlanRef | VLAN reference. |
[in] | phoneId | Phone for VLAN association. |
[in] | profileId | Profile ID for VLAN association. |
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.
[in] | vlanRef | VLAN reference. |
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.
[in] | enableMss | Enable TCP MSS to be clamped on L2TP interfaces. |
[in] | enableMtu | Enable MTU size to be set on underlying interfaces. |
[in] | mtuSize | Optional MTU size in bytes; default is 1422. |
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.
[in] | enableMss | Enable TCP MSS to be clamped on L2TP interfaces. |
[in] | enableMtu | Enable MTU size to be set on underlying interfaces. |
[in] | mtuSize | optional MTU size in bytes; default is 1422. |
[in] | handlerPtr | The handler. |
[in] | contextPtr |
LE_SHARED le_result_t ifgen_taf_net_DisableL2tp | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Disables (synchronously) L2TP for unmanaged tunnel state.
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.
[in] | handlerPtr | The handler. |
[in] | contextPtr |
LE_SHARED bool ifgen_taf_net_IsL2tpEnabled | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Determines if L2TP is enabled.
LE_SHARED bool ifgen_taf_net_IsL2tpMssEnabled | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Determines if maximum segment size (MSS) is enabled.
LE_SHARED bool ifgen_taf_net_IsL2tpMtuEnabled | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Determines if maximum transmission unit (MTU) is enabled.
LE_SHARED uint32_t ifgen_taf_net_GetL2tpMtuSize | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Gets L2TP MTU size.
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.
[in] | encaProto | Encapsulation protocol, UDP or IP. |
[in] | locId | Local tunnel ID. |
[in] | peerId | Peer tunnel ID. |
[in] | peerIpAddr | Peer IP address. |
[in] | ifName | Interface name. |
LE_SHARED le_result_t ifgen_taf_net_RemoveTunnel | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_net_TunnelRef_t | tunnelRef | ||
) |
Removes an L2TP tunnel.
[in] | tunnelRef | Tunnel reference. |
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.
[in] | tunnelRef | Tunnel reference. |
[in] | localUdpPort | Local UDP port, if UDP encapsulation is used. |
[in] | peerUdpPort | Peer UDP port, if IP encapsulation is used. |
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.
[in] | tunnelRef | Tunnel reference. |
[in] | locId | Local session ID. |
[in] | peerId | Peer session ID. |
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.
[in] | tunnelRef | Tunnel reference. |
[in] | locId | Local session ID. |
[in] | peerId | Peer session ID. |
LE_SHARED le_result_t ifgen_taf_net_StartTunnel | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_net_TunnelRef_t | tunnelRef | ||
) |
Starts (synchronously) a tunnel.
[in] | tunnelRef | Tunnel reference. |
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.
[in] | tunnelRef | Tunnel reference. |
[in] | handlerPtr | The handler. |
[in] | contextPtr |
LE_SHARED le_result_t ifgen_taf_net_StopTunnel | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_net_TunnelRef_t | tunnelRef | ||
) |
Stops (synchronously) a tunnel.
[in] | tunnelRef | Tunnel reference. |
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.
[in] | tunnelRef | Tunnel reference. |
[in] | handlerPtr | The handler. |
[in] | contextPtr |
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.
[in] | locId | Local tunnel ID. |
LE_SHARED taf_net_TunnelEntryListRef_t ifgen_taf_net_GetTunnelEntryList | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Gets the tunnel entry list.
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.
[in] | tunnelEntryListRef | Reference of a tunnel entry list. |
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.
[in] | tunnelEntryListRef | Reference of a tunnel entry list. |
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.
[in] | tunnelEntryListRef | Reference of a tunnel entry list. |
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.
[in] | tunnelEntryRef | Tunnel entry reference. |
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.
[in] | tunnelEntryRef | Tunnel entry reference. |
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.
[in] | tunnelEntryRef | Tunnel entry reference. |
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.
[in] | tunnelEntryRef | Tunnel entry reference. |
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.
[in] | tunnelEntryRef | Tunnel entry reference. |
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.
[in] | tunnelEntryRef | Tunnel entry reference. |
[out] | peerIpv6Addr | Peer IPv6 address. |
[in] | 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 | ||
) |
Gets the peer IPv4 address of a tunnel.
[in] | tunnelEntryRef | Tunnel entry reference. |
[out] | peerIpv4Addr | Peer IPv4 address. |
[in] | 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 | ||
) |
Gets the interface name of a tunnel.
[in] | tunnelEntryRef | Tunnel entry reference. |
[out] | ifName | Interface name. |
[in] | ifNameSize |
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.
[in] | tunnelEntryRef | Tunnel entry reference. |
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.
[in] | tunnelEntryRef | Tunnel entry reference. |
[out] | sessionConfigPtr | Session configuration. |
[in,out] | sessionConfigSizePtr |
LE_SHARED le_result_t ifgen_taf_net_EnableSocks | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Enables (synchronously) the SOCKS proxy service.
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.
[in] | handlerPtr | The handler. |
[in] | contextPtr |
LE_SHARED le_result_t ifgen_taf_net_DisableSocks | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Disables (synchronously) the SOCKS proxy service.
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.
[in] | handlerPtr | The handler. |
[in] | contextPtr |
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.
[in] | authMethod | Authentication method. |
LE_SHARED taf_net_AuthMethod_t ifgen_taf_net_GetSocksAuthMethod | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Gets the SOCKS authentication method.
LE_SHARED le_result_t ifgen_taf_net_SetSocksLanInterface | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
const char *LE_NONNULL | ifName | ||
) |
Sets SOCKS LAN interface.
[in] | ifName | Interface name. |
LE_SHARED le_result_t ifgen_taf_net_GetSocksLanInterface | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
char * | ifName, | ||
size_t | ifNameSize | ||
) |
Gets SOCKS LAN interface.
[out] | ifName | Interface name. |
[in] | ifNameSize |
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.
[in] | userName | Username. |
[in] | profileId | Profile ID. |
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.
[in] | userName | 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 | ||
) |
Adds GSB configuration for an interface.
[in] | ifName | Interface name. |
[in] | ifType | Interface type. |
[in] | bandwidth | Bandwidth (in Mbps). |
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.
[in] | ifName | Interface name. |
LE_SHARED le_result_t ifgen_taf_net_EnableGsb | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Enables GSB in the system.
LE_SHARED le_result_t ifgen_taf_net_DisableGsb | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Disables GSB in the system.
LE_SHARED taf_net_GsbListRef_t ifgen_taf_net_GetGsbList | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Gets GSB list.
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.
[in] | gsbListRef | Reference of a GSB list. |
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.
[in] | gsbListRef | Reference of a GSB list. |
LE_SHARED le_result_t ifgen_taf_net_DeleteGsbList | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_net_GsbListRef_t | gsbListRef | ||
) |
Deletes the GSB list.
[in] | gsbListRef | Reference of a GSB list. |
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.
[in] | gsbRef | GSB reference. |
[out] | IfName | Interface name. |
[in] | IfNameSize |
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.
[in] | gsbRef | GSB reference. |
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.
[in] | gsbRef | GSB reference. |