Telematics SDK - API Reference
v1.63.4
|
Data Structures | |
struct | telux::tel::ServingSystemInfo |
struct | telux::tel::RFBandInfo |
struct | telux::tel::DcStatus |
struct | telux::tel::NetworkTimeInfo |
class | telux::tel::IServingSystemManager |
class | telux::tel::IServingSystemListener |
Listener class for getting notifications related to updates in radio access technology mode preference, service domain preference, serving system information, etc. Some notifications in this listener could be frequent in nature. When the system is in a suspended/low power state, those indications will wake the system up. This could result in increased power consumption by the system. If those notifications are not required in the suspended/low power state, it is recommended for the client to de-register specific notifications using the deregisterListener API. More... | |
Typedefs | |
using | telux::tel::RatPreference = std::bitset< 16 > |
using | telux::tel::ServingSystemNotificationMask = std::bitset< 32 > |
using | telux::tel::RatPreferenceCallback = std::function< void(RatPreference preference, telux::common::ErrorCode error)> |
using | telux::tel::ServiceDomainPreferenceCallback = std::function< void(ServiceDomainPreference preference, telux::common::ErrorCode error)> |
using | telux::tel::NetworkTimeResponseCallback = std::function< void(NetworkTimeInfo info, telux::common::ErrorCode error)> |
Serving System Manager class provides the API to request and set service domain preference and RAT preference. More... | |
using | telux::tel::RFBandInfoCallback = std::function< void(RFBandInfo bandInfo, telux::common::ErrorCode error)> |
Serving System Manager class provides the interface to request and set service domain preference and radio access technology mode preference for searching and registering (CS/PS domain, RAT and operation mode)
struct telux::tel::ServingSystemInfo |
Defines current serving system information
Data Fields | ||
---|---|---|
RadioTechnology | rat |
Current serving RAT |
ServiceDomain | domain |
Current service domain registered on system for the serving RAT |
struct telux::tel::RFBandInfo |
Defines information of RF bands.
Data Fields | ||
---|---|---|
RFBand | band |
Currently active band |
uint32_t | channel |
Currently active channel |
RFBandWidth | bandWidth |
Bandwidth information |
struct telux::tel::DcStatus |
Defines Dual Connectivity status
Data Fields | ||
---|---|---|
EndcAvailability | endcAvailability |
ENDC availability |
DcnrRestriction | dcnrRestriction |
DCNR restriction |
struct telux::tel::NetworkTimeInfo |
Defines Network time information
class telux::tel::IServingSystemManager |
|
virtual |
Destructor of IServingSystemManager
|
pure virtual |
Checks the status of serving subsystem and returns the result.
|
pure virtual |
Wait for serving subsystem to be ready.
|
pure virtual |
This status indicates whether the IServingSystemManager object is in a usable state.
|
pure virtual |
Set the preferred radio access technology mode that the device should use to acquire service.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_CONFIG permission to invoke this API successfully.
[in] | ratPref | Radio access technology mode preference. |
[in] | callback | Callback function to get the response of set RAT mode preference. |
|
pure virtual |
Request for preferred radio access technology mode.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_READ permission to invoke this API successfully.
[in] | callback | Callback function to get the response of request preferred RAT mode. |
|
pure virtual |
Initiate service domain preference like CS, PS or CS_PS and receive the response asynchronously.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_CONFIG permission to invoke this API successfully.
[in] | serviceDomain | ServiceDomainPreference. |
[in] | callback | Callback function to get the response of set service domain preference request. |
|
pure virtual |
Request for Service Domain Preference asynchronously.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_READ permission to invoke this API successfully.
[in] | callback | Callback function to get the response of request service domain preference. |
|
pure virtual |
Get the Serving system information. Supports only 3GPP RATs.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_READ permission to invoke this API successfully.
[out] | sysInfo | Serving system information ServingSystemInfo |
|
pure virtual |
Request for Dual Connectivity status on 5G NR.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_READ permission to invoke this API successfully.
|
pure virtual |
Get network time information asynchronously.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_READ permission to invoke this API successfully.
[in] | callback | Callback function to get the response of get network time information request. |
|
pure virtual |
Get the information about the band that the device is currently using.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_READ permission to invoke this API successfully.
[in] | callback | Callback function to get the response of get RF band information request. |
|
pure virtual |
Register a listener for specific updates from serving system.
[in] | listener | Pointer of IServingSystemListener object that processes the notification |
[in] | mask | Bit mask representing a set of notifications that needs to be registered - ServingSystemNotificationMask Notifications under IServingSystemListener that are not listed in in ServingSystemNotificationType would always be registered by default. All the notifications will be registered when the client provides ALL_NOTIFICATIONS as input. The bits that are not set in the mask are ignored and do not have any effect on registration. To deregister, the API deregisterListener should be used. |
|
pure virtual |
Deregister the previously added listener.
[in] | listener | Previously registered IServingSystemListener that needs to be removed |
[in] | mask | Bit mask that denotes a set of notifications that needs to be de-registered - ServingSystemNotificationMask Notifications under IServingSystemListener that are not listed in ServingSystemNotificationType will be de-registered only when ALL_NOTIFICATIONS is provided as input. The bits that are not set in the mask are ignored and does not have any effect on de-registration. However, providing an empty mask is an invalid operation. To register again, the API registerListener should be used. |
|
static |
Represents the set of all notifications defined in ServingSystemNotificationType. When this constant value is provided for registration or deregistration, all notifications will be registered or deregistered.
class telux::tel::IServingSystemListener |
Listener class for getting notifications related to updates in radio access technology mode preference, service domain preference, serving system information, etc. Some notifications in this listener could be frequent in nature. When the system is in a suspended/low power state, those indications will wake the system up. This could result in increased power consumption by the system. If those notifications are not required in the suspended/low power state, it is recommended for the client to de-register specific notifications using the deregisterListener API.
The listener method can be invoked from multiple different threads. Client needs to make sure that implementation is thread-safe.
Public Member Functions | |
virtual void | onRatPreferenceChanged (RatPreference preference) |
virtual void | onServiceDomainPreferenceChanged (ServiceDomainPreference preference) |
virtual void | onSystemInfoChanged (ServingSystemInfo sysInfo) |
virtual void | onDcStatusChanged (DcStatus dcStatus) |
virtual void | onNetworkTimeChanged (NetworkTimeInfo info) |
virtual void | onRFBandInfoChanged (RFBandInfo bandInfo) |
virtual | ~IServingSystemListener () |
Public Member Functions inherited from telux::common::IServiceStatusListener | |
virtual void | onServiceStatusChange (ServiceStatus status) |
virtual | ~IServiceStatusListener () |
|
virtual |
Destructor of IServingSystemListener
|
virtual |
This function is called whenever RAT mode preference is changed.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_READ permission to receive this notification.
[in] | preference | RatPreference |
|
virtual |
This function is called whenever service domain preference is changed.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_READ permission to receive this notification.
[in] | preference | ServiceDomainPreference |
|
virtual |
This function is called whenever the Serving System information is changed. Supports only 3GPP RATs.
To receive this notification, client needs to register a listener using registerListener API by setting the ServingSystemNotificationType::SYSTEM_INFO bit in the bitmask.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_READ permission to receive this notification.
[in] | sysInfo | ServingSystemInfo |
|
virtual |
This function is called whenever the Dual Connnectivity status is changed on 5G NR.
To receive this notification, client needs to register a listener using registerListener API by setting the ServingSystemNotificationType::SYSTEM_INFO bit in the bitmask.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_READ permission to receive this notification.
[in] | dcStatus | DcStatus |
|
virtual |
This function is called whenever network time information is changed.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_READ permission to receive this notification.
[in] | info | Network time information NetworkTimeInfo |
|
virtual |
This function is called whenever the RF band information changes.
To receive this notification, client needs to register a listener using registerListener API by setting the ServingSystemNotificationType::RF_BAND_INFO bit in the bitmask.
On platforms with Access control enabled, Caller needs to have TELUX_TEL_SRV_SYSTEM_READ permission to receive this notification.
[in] | bandInfo | RFBandInfo |
using telux::tel::RatPreference = typedef std::bitset<16> |
16 bit mask that denotes which of the radio access technology mode preference defined in RatPrefType enum are used to set or get RAT preference.
using telux::tel::ServingSystemNotificationMask = typedef std::bitset<32> |
Bit mask that denotes a set of notifications defined in ServingSystemNotificationType
using telux::tel::RatPreferenceCallback = typedef std::function<void(RatPreference preference, telux::common::ErrorCode error)> |
This function is called with the response to requestRatPreference API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | preference | RatPreference |
[in] | error | Return code which indicates whether the operation succeeded or not ErrorCode |
using telux::tel::ServiceDomainPreferenceCallback = typedef std::function<void(ServiceDomainPreference preference, telux::common::ErrorCode error)> |
This function is called with the response to requestServiceDomainPreference API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | preference | ServiceDomainPreference |
[in] | error | Return code which indicates whether the operation succeeded or not ErrorCode |
using telux::tel::NetworkTimeResponseCallback = typedef std::function<void(NetworkTimeInfo info, telux::common::ErrorCode error)> |
Serving System Manager class provides the API to request and set service domain preference and RAT preference.
This function is called with the response to requestNetworkTime API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | info | NetworkTimeInfo |
[in] | error | Return code which indicates whether the operation succeeded or not ErrorCode |
using telux::tel::RFBandInfoCallback = typedef std::function<void(RFBandInfo bandInfo, telux::common::ErrorCode error)> |
This function is called with the response to requestRFBandInfo API.
The callback can be invoked from multiple different threads. The implementation should be thread safe.
[in] | bandInfo | RFBandInfo |
[in] | error | Return code which indicates whether the operation succeeded or not ErrorCode |
|
strong |
|
strong |
|
strong |
Defines RF Bands.
|
strong |
Defines RF Bandwidth Information.
|
strong |
|
strong |
Defines some of the notifications supported by IServingSystemListener which can be dynamically disabled/enabled. Each entry represents one or more listener callbacks in IServingSystemListener
Enumerator | |
---|---|
SYSTEM_INFO | |
RF_BAND_INFO |