Telematics SDK - Interface Specification  v1.43.0
Telematics_data_serving_system

Detailed Description

Data Structure Documentation

class telux::data::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.

Public member functions

virtual telux::common::ServiceStatus getServiceStatus ()=0
 
virtual DrbStatus getDrbStatus ()=0
 
virtual telux::common::Status registerListener (std::weak_ptr< IServingSystemListener > listener)=0
 
virtual telux::common::Status deregisterListener (std::weak_ptr< IServingSystemListener > listener)=0
 
virtual SlotId getSlotId ()=0
 
virtual ~IServingSystemManager ()
 

Constructors and Destructors

virtual telux::data::IServingSystemManager::~IServingSystemManager ( )
virtual

Destructor of IServingSystemManager

Member Function Documentation

virtual telux::common::ServiceStatus telux::data::IServingSystemManager::getServiceStatus ( )
pure virtual

Checks the status of serving manager object and returns the result.

Returns
SERVICE_AVAILABLE - If serving manager object is ready for service. SERVICE_UNAVAILABLE - If serving manager object is temporarily unavailable. SERVICE_FAILED - If serving manager object encountered an irrecoverable failure.
Note
Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.
virtual DrbStatus telux::data::IServingSystemManager::getDrbStatus ( )
pure virtual

get the dedicated radio bearer (DRB) status

Returns
current DrbStatus DrbStatus.
Note
Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.
virtual telux::common::Status telux::data::IServingSystemManager::registerListener ( std::weak_ptr< IServingSystemListener >  listener)
pure virtual

Register a listener for specific updates from serving system.

Parameters
[in]listenerPointer of IServingSystemListener object that processes the notification
Returns
Status of registerListener i.e success or suitable status code.
virtual telux::common::Status telux::data::IServingSystemManager::deregisterListener ( std::weak_ptr< IServingSystemListener >  listener)
pure virtual

Deregister the previously added listener.

Parameters
[in]listenerPreviously registered IServingSystemListener that needs to be removed
Returns
Status of removeListener i.e. success or suitable status code
virtual SlotId telux::data::IServingSystemManager::getSlotId ( )
pure virtual

Get associated slot id for the Serving System Manager.

Returns
SlotId
class telux::data::IServingSystemListener

Listener class for data serving system change notification.

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 onServiceStatusChange (telux::common::ServiceStatus status)
 
virtual void onDrbStatusChanged (DrbStatus status)
 
virtual ~IServingSystemListener ()
 

Constructors and Destructors

virtual telux::data::IServingSystemListener::~IServingSystemListener ( )
virtual

Destructor of IServingSystemListener

Member Function Documentation

virtual void telux::data::IServingSystemListener::onServiceStatusChange ( telux::common::ServiceStatus  status)
virtual

This function is called when service status changes.

Parameters
[in]status- ServiceStatus
virtual void telux::data::IServingSystemListener::onDrbStatusChanged ( DrbStatus  status)
virtual

This function is called whenever Drb status is changed.

Parameters
[in]statusDrbStatus

Enumeration Type Documentation

enum telux::data::DrbStatus
strong

Dedicated Radio Bearer (DRB) status.

Enumerator
ACTIVE 
DORMANT 
UNKNOWN