Telematics SDK - Interface Specification
v1.43.0
|
Namespaces | |
net | |
Data Structures | |
struct | DataCallEndReason |
union | DataCallEndReason.__unnamed__ |
struct | DataCallStats |
class | DataFactory |
DataFactory is the central factory to create all data classes. More... | |
class | DataProfile |
DataProfile class represents single data profile on the modem. More... | |
struct | DataRestrictMode |
struct | EspInfo |
struct | IcmpInfo |
class | IDataCall |
Represents single established data call on the device. More... | |
class | IDataConnectionListener |
class | IDataConnectionManager |
IDataConnectionManager is a primary interface for cellular connectivity This interface provides APIs for start and stop data call connections, get data call information and listener for monitoring data calls. It also provides interface to Subsystem Restart events by registering as listener. Notifications will be received when modem is ready/not ready. More... | |
class | IDataCreateProfileCallback |
class | IDataFilterListener |
Listener class for listening to filtering mode notifications, like Data filtering mode change. Client need to implement these methods. The methods in listener can be invoked from multiple threads. So the client needs to make sure that the implementation is thread-safe. More... | |
class | IDataFilterManager |
IDataFilterManager class provides interface to enable/disable the data restrict filters and register for data restrict filter. The filtering can be done at any time. One such use case is to do it when we want the AP to suspend so that we are not waking up the AP due to spurious incoming messages. Also to make sure the DataRestrict mode is enabled. More... | |
class | IDataProfileCallback |
class | IDataProfileListCallback |
Interface for getting list of DataProfile using callback. Client needs to implement this interface to get single shot responses for commands like get profile list and query profile. More... | |
class | IDataProfileListener |
Listener class for getting profile change notification. More... | |
class | IDataProfileManager |
class | IEspFilter |
This class represents a IP Filter for the ESP, get the new instance from telux::data::DataFactory. More... | |
class | IIcmpFilter |
This class represents a IP Filter for the ICMP, get the new instance from telux::data::DataFactory. More... | |
class | IIpFilter |
A IP filter class to add specific filters like what data will be allowed from the modem to the application processor. Only data packets that match the filter will be sent to the apps processor. Also used to configure Firewall rules. More... | |
struct | IpAddrInfo |
struct | IpFamilyInfo |
struct | IPv4Info |
struct | IPv6Info |
class | IServingSystemListener |
Listener class for data serving system change notification. More... | |
class | IServingSystemManager |
Serving System Manager class provides APIs related to the serving system for data functionality. For example, ability to query or be notified about the state of the platform's WWAN PS data serving information. More... | |
class | ITcpFilter |
This class represents a IP Filter for the TCP, get the new instance from telux::data::DataFactory. More... | |
class | IUdpFilter |
This class represents a IP Filter for the UDP, get the new instance from telux::data::DataFactory. More... | |
struct | PortInfo |
struct | ProfileParams |
struct | TcpInfo |
struct | UdpInfo |
struct | VlanConfig |
struct telux::data::EspInfo |
struct telux::data::IcmpInfo |
struct telux::data::IpFamilyInfo |
IP Family related Info
Data Fields | ||
---|---|---|
DataCallStatus | status | |
IpAddrInfo | addr |
struct telux::data::IPv4Info |
IPv4 header info
Data Fields | ||
---|---|---|
string | srcAddr |
address of the device that sends the packet. |
string | srcSubnetMask | |
string | destAddr |
address of receiving end |
string | destSubnetMask | |
TypeOfService | value |
level of throughput, reliability, and delay |
TypeOfService | mask | |
IpProtocol | nextProtoId |
Protocol ID (i.e TCP, UDP or ICMP ) |
struct telux::data::IPv6Info |
IPv6 header info
Data Fields | ||
---|---|---|
string | srcAddr |
address of the device that sends the packet. |
uint8_t | srcPrefixLen |
source prefix length used to create subnet |
string | destAddr |
address of receiving end |
uint8_t | dstPrefixLen |
destination prefix length used to create subnet |
IpProtocol | nextProtoId |
Protocol ID (i.e TCP, UDP or ICMP ) |
TrafficClass | val |
indicates the class or priority of the IPv6 packet, enables the ability to track specific traffic flows at the network layer. |
TrafficClass | mask | |
FlowLabel | flowLabel |
Indicates that this packet belongs to a specific sequence of packets between a source and destination, requiring special handling by intermediate IPv6 routers. |
uint8_t | natEnabled |
struct telux::data::TcpInfo |
struct telux::data::UdpInfo |
using telux::data::DataCallResponseCb = typedef std::function<void( const std::shared_ptr<IDataCall> &dataCall, telux::common::ErrorCode error)> |
This function is called with the response to startDataCall / stopDataCall API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | dataCall | Pointer to IDataCall |
[in] | error | Return code for whether the operation succeeded or failed |
using telux::data::StatisticsResponseCb = typedef std::function<void(const DataCallStats dataStats, telux::common::ErrorCode error)> |
This function is called with the response to requestDataCallStatistics API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | dataStats | Data Call statistics |
[in] | error | Return code for whether the operation succeeded or failed |
using telux::data::DataCallListResponseCb = typedef std::function<void( const std::vector<std::shared_ptr<IDataCall>> &dataCallList, telux::common::ErrorCode error)> |
This function is called with the response to requestDataCallList API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | dataCall | vector of of IDataCall list |
[in] | error | Return code for whether the operation succeeded or failed |
using telux::data::DefaultProfileIdResponseCb = typedef std::function<void(int profileId, SlotId slotId, telux::common::ErrorCode error)> |
This function is called with the response to getDefaultProfile API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | profileId | Current default profile id |
[in] | slotId | Slot id that contains current default profile id |
[in] | error | Return code for whether the operation succeeded or failed |
using telux::data::DataRestrictModeCb = typedef std::function<void(DataRestrictMode mode, telux::common::ErrorCode error)> |
This function is called in the response to requestDataRestrictMode().
[in] | mode | Return current data restrict mode. |
[in] | error | Return code which indicates whether the operation succeeded or not. ErrorCode. |
using telux::data::TypeOfService = typedef uint8_t |
using telux::data::TrafficClass = typedef uint8_t |
using telux::data::FlowLabel = typedef uint32_t |