Telematics SDK - Interface Specification  v1.25.0
 All Data Structures Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
telux::data::net Namespace Reference

Data Structures

class  IFirewallManager
 FirewallManager is a primary interface that filters and controls the network traffic on a pre-configured set of rules. More...
 
class  IFirewallEntry
 Firewall entry class is used for configuring firewall rules. More...
 
struct  NatConfig
 
class  INatManager
 NatManager is a primary interface for configuring static network address translation(SNAT) and DMZ (demilitarized zone) More...
 
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. More...
 

Typedefs

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 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)>
 

Typedef Documentation

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]enableIndicates whether the firewall is enabled
[in]allowPacketsIndicates whether to accept or drop packets matching the rules
[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::FirewallEntriesCb = typedef std::function<void( std::vector<std::shared_ptr<IFirewallEntry>> entries, telux::common::ErrorCode error)>

This function is called as a response to requestFirewallEntry()

Parameters
[in]entrieslist of firewall entries
[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::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]dmzEntrieslist of dmz entries
[in]errorReturn 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]snatEntrieslist of static Network Address Translation (NAT)
[in]errorReturn 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]isAcceleratedOffload status returned by server
[in]errorReturn 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]configsList of VLAN configs
[in]errorReturn 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]mappingList of profile Id and Vlan id map Key is Profile Id and value is VLAN id
[in]errorReturn 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.