Data Structures
struct	BridgeInfo

struct	DmzConfig

struct	FirewallConfig

struct	FirewallEntryInfo

class	IBridgeListener

class	IBridgeManager
	IBridgeManager provides APIs to enable/disable and set/get/delete software bridges for various WLAN and Ethernet interfaces. It also provides interface to Subsystem Restart events by registering as listener. Notifications will be received when modem is ready/not ready. More...

class	IFirewallEntry
	Firewall entry class is used for configuring firewall rules. More...

class	IFirewallListener

class	IFirewallManager
	FirewallManager is a primary interface that filters and controls the network traffic on a pre-configured set of rules. It also provides interface to Subsystem Restart events by registering as listener. Notifications will be received when modem is ready/not ready. More...

class	IL2tpListener

class	IL2tpManager
	L2tpManager is a primary interface for configuring L2TP Service. It also provides interface to Subsystem Restart events by registering as listener. Notifications will be received when modem is ready/not ready. More...

class	INatListener

class	INatManager
	NatManager is a primary interface for configuring static network address translation(SNAT) and DMZ (demilitarized zone). It also provides interface to Subsystem Restart events by registering as listener. Notifications will be received when modem is ready/not ready. More...

class	ISocksListener

class	ISocksManager
	SocksManager is a primary interface for configuring legacy Socks proxy server. It also provides interface to Subsystem Restart events by registering as listener. Notifications will be received when modem is ready/not ready. More...

class	IVlanListener

class	IVlanManager
	VlanManager is a primary interface for configuring VLAN (Virtual Local Area Network). it provide APIs for create, query, remove VLAN interfaces and associate or disassociate with profile IDs. It also provides interface to Subsystem Restart events by registering as listener. Notifications will be received when modem is ready/not ready. More...

struct	L2tpSessionConfig

struct	L2tpSysConfig

struct	L2tpTunnelConfig

struct	NatConfig

struct	VlanBindConfig

Typedefs
using	BridgeInfoResponseCb = std::function< void(const std::vector< BridgeInfo > &infos, telux::common::ErrorCode error)>

using	FirewallConfigCb = std::function< void(FirewallConfig status, telux::common::ErrorCode error)>

using	FirewallEntryInfoCb = std::function< void(std::vector< FirewallEntryInfo > entry, telux::common::ErrorCode error)>

using	DmzEntryInfoCb = std::function< void(std::vector< DmzConfig > dmzEntries, telux::common::ErrorCode error)>

using	FirewallStatusCb = std::function< void(bool enable, bool allowPackets, telux::common::ErrorCode error)>

using	FirewallEntriesCb = std::function< void(std::vector< std::shared_ptr< IFirewallEntry >> entries, telux::common::ErrorCode error)>

using	DmzEntriesCb = std::function< void(std::vector< std::string > dmzEntries, telux::common::ErrorCode error)>

using	L2tpConfigCb = std::function< void(const L2tpSysConfig &l2tpSysConfig, telux::common::ErrorCode error)>

using	StaticNatEntriesCb = std::function< void(const std::vector< NatConfig > &snatEntries, telux::common::ErrorCode error)>

using	CreateVlanCb = std::function< void(bool isAccelerated, telux::common::ErrorCode error)>

using	QueryVlanResponseCb = std::function< void(const std::vector< VlanConfig > &configs, telux::common::ErrorCode error)>

using	VlanMappingResponseCb = std::function< void(const std::list< std::pair< int, int >> &mapping, telux::common::ErrorCode error)>

using	VlanBindingsResponseCb = std::function< void(const std::vector< VlanBindConfig > bindings, telux::common::ErrorCode error)>

Enumerations
enum	BridgeIFaceType { BridgeIFaceType::UNKNOWN = 0, BridgeIFaceType::WLAN_AP = 1, BridgeIFaceType::WLAN_STA = 2, BridgeIFaceType::ETH = 3 }

enum	L2tpProtocol { L2tpProtocol::NONE = 0, L2tpProtocol::IP = 0x01, L2tpProtocol::UDP = 0x02 }

Data Structure Documentation

struct telux::data::net::BridgeInfo

Structure to configure a software bridge for an interface

Data Fields
string	ifaceName	Interface name
BridgeIFaceType	ifaceType	Interface type
uint32_t	bandwidth	Bandwidth(in Mbps) required for software bridge

struct telux::data::net::DmzConfig

DMZ configuration parameters

Data Fields
BackhaulInfo	bhInfo	Backhaul Information to apply firewal settings on
string	ipAddr	IP address for which DMZ will be enabled

struct telux::data::net::FirewallConfig

Firewall configuration parameters

Data Fields
BackhaulInfo	bhInfo	Backhaul Information to apply firewal settings on
bool	enable	True: Firewall enabled. False: Firewall disabled
bool	allowPackets	True: Packets that match rules will be allowed. False: Packets that match rules will be dropped

struct telux::data::net::FirewallEntryInfo

Firewall rules parameters

Data Fields
shared_ptr< IFirewallEntry >	fwEntry	Shared pointer to firewall rules for the backhaul
BackhaulInfo	bhInfo	Backhaul Information to add firewal rules on

struct telux::data::net::VlanBindConfig

Data Fields
int	vlanId
BackhaulInfo	bhInfo	VLAN ID to be bound to the specified backhaul Configuration of Backhaul to bind VLAN to

Typedef Documentation

using telux::data::net::BridgeInfoResponseCb = typedef std::function<void(const std::vector<BridgeInfo> &infos, telux::common::ErrorCode error)>

This function is called as a response to requestBridgeInfo

Parameters

[in]	infos	List of the software bridge configurations in the system
[in]	error	Return code which indicates whether the operation is succeeded or not telux::common::ErrorCode

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

using telux::data::net::FirewallConfigCb = typedef std::function<void(FirewallConfig status, telux::common::ErrorCode error)>

This function is called as a response to requestFirewallConfig()

Parameters

[in]	config	Firewall configuration status for specific backhaul telux::data::FirewallConfig.
[in]	error	Return code which indicates whether the operation succeeded or not. telux::common::ErrorCode

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

using telux::data::net::FirewallEntryInfoCb = typedef std::function<void( std::vector<FirewallEntryInfo> entry, telux::common::ErrorCode error)>

This function is called as a response to requestFirewallEntries()

Parameters

[in]	entries	Vector of firewall entries for specific backhaul
[in]	error	Return code which indicates whether the operation succeeded or not. telux::common::ErrorCode

using telux::data::net::DmzEntryInfoCb = typedef std::function<void(std::vector<DmzConfig> dmzEntries, telux::common::ErrorCode error)>

This function is called as a response to requestDmzEntries()

Parameters

[in]	dmzEntries	list of dmz entries configurations
[in]	error	Return code which indicates whether the operation succeeded or not. telux::common::ErrorCode

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

using telux::data::net::FirewallStatusCb = typedef std::function<void(bool enable, bool allowPackets, telux::common::ErrorCode error)>

This function is called as a response to requestFirewallStatus()

Parameters

[in]	enable	Indicates whether the firewall is enabled
[in]	allowPackets	Indicates whether to accept or drop packets matching the rules
[in]	error	Return code which indicates whether the operation succeeded or not. telux::common::ErrorCode

Deprecated:: telux::data::FirewallConfigCb callback is used to get Firewall configuration

using telux::data::net::FirewallEntriesCb = typedef std::function<void( std::vector<std::shared_ptr<IFirewallEntry>> entries, telux::common::ErrorCode error)>

This function is called as a response to requestFirewallEntries()

Parameters

[in]	entries	list of firewall entries
[in]	error	Return code which indicates whether the operation succeeded or not. telux::common::ErrorCode

Deprecated:: telux::data::FirewallEntryInfoCb callback is used to get Firewall entries

using telux::data::net::DmzEntriesCb = typedef std::function<void(std::vector<std::string> dmzEntries, telux::common::ErrorCode error)>

This function is called as a response to requestDmzEntries()

Parameters

[in]	dmzEntries	list of dmz entries
[in]	error	Return code which indicates whether the operation succeeded or not. telux::common::ErrorCode

Deprecated:: telux::data::DmzEntryInfoCb callback is used to get DMZ entries

using telux::data::net::L2tpConfigCb = typedef std::function<void(const L2tpSysConfig &l2tpSysConfig, telux::common::ErrorCode error)>

This function is called as a response to requestConfig()

Parameters

[in]	l2tpSysConfig	Current L2TP configuration
[in]	error	Return code which indicates whether the operation succeeded or not telux::common::ErrorCode

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

using telux::data::net::StaticNatEntriesCb = typedef std::function<void(const std::vector<NatConfig> &snatEntries, telux::common::ErrorCode error)>

This function is called as a response to requestStaticNatEntries()

Parameters

[in]	snatEntries	list of static Network Address Translation (NAT)
[in]	error	Return code which indicates whether the operation succeeded or not telux::common::ErrorCode

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

using telux::data::net::CreateVlanCb = typedef std::function<void(bool isAccelerated, telux::common::ErrorCode error)>

This function is called as a response to createVlan()

Parameters

[in]	isAccelerated	Offload status returned by server
[in]	error	Return code which indicates whether the operation succeeded or not telux::common::ErrorCode

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

using telux::data::net::QueryVlanResponseCb = typedef std::function<void(const std::vector<VlanConfig> &configs, telux::common::ErrorCode error)>

This function is called as a response to queryVlanInfo()

Parameters

[in]	configs	List of VLAN configs
[in]	error	Return code which indicates whether the operation succeeded or not telux::common::ErrorCode

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

using telux::data::net::VlanMappingResponseCb = typedef std::function<void( const std::list<std::pair<int, int>> &mapping, telux::common::ErrorCode error)>

This function is called as a response to queryVlanMappingList()

Parameters

[in]	mapping	List of profile Id and Vlan id map Key is Profile Id and value is VLAN id
[in]	error	Return code which indicates whether the operation succeeded or not telux::common::ErrorCode

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

Enumeration Type Documentation

enum telux::data::net::BridgeIFaceType

strong

Interface types supported for bridge configuration

Enumerator
UNKNOWN
WLAN_AP	Wireless Local Area Network (WLAN) in AP mode
WLAN_STA	Wireless Local Area Network (WLAN) in STA mode
ETH	Ethernet (ETH)

Data Structures

Typedefs

Enumerations

Data Structure Documentation

Typedef Documentation

Enumeration Type Documentation