Data Structures
struct	telux::tel::PreferredNetworkInfo

struct	telux::tel::OperatorStatus

class	telux::tel::INetworkSelectionManager
	Network Selection Manager class provides the interface to get and set network selection mode, preferred network list and scan available networks. More...

class	telux::tel::OperatorInfo

class	telux::tel::INetworkSelectionListener
	Listener class for getting network selection mode change notification. More...

Enumerations
enum	telux::tel::RatType { telux::tel::UMTS = 15, telux::tel::LTE = 14, telux::tel::LTE = 3, telux::tel::GSM = 7, telux::tel::GSM = 1, telux::tel::NR5G = 11 }

enum	telux::tel::NetworkScanStatus { telux::tel::NetworkScanStatus::COMPLETE = 0, telux::tel::NetworkScanStatus::PARTIAL = 1, telux::tel::NetworkScanStatus::FAILED = 2 }

enum	telux::tel::NetworkSelectionMode { telux::tel::NetworkSelectionMode::UNKNOWN = -1, telux::tel::NetworkSelectionMode::AUTOMATIC = 0, telux::tel::NetworkSelectionMode::MANUAL = 1 }

enum	telux::tel::InUseStatus { telux::tel::InUseStatus::UNKNOWN, telux::tel::InUseStatus::CURRENT_SERVING, telux::tel::InUseStatus::AVAILABLE }

enum	telux::tel::RoamingStatus { telux::tel::RoamingStatus::UNKNOWN, telux::tel::RoamingStatus::HOME, telux::tel::RoamingStatus::ROAM }

enum	telux::tel::ForbiddenStatus { telux::tel::ForbiddenStatus::UNKNOWN, telux::tel::ForbiddenStatus::FORBIDDEN, telux::tel::ForbiddenStatus::NOT_FORBIDDEN }

enum	telux::tel::PreferredStatus { telux::tel::PreferredStatus::UNKNOWN, telux::tel::PreferredStatus::PREFERRED, telux::tel::PreferredStatus::NOT_PREFERRED }

Detailed Description

Network Selection Manager provides the interface to get and set network selection mode (Manual or Automatic), scan available networks and set and get preferred networks list.

Data Structure Documentation

struct telux::tel::PreferredNetworkInfo

Defines the preferred network information

Data Fields
uint16_t	mcc	mobile country code
uint16_t	mnc	mobile network code
RatMask	ratMask	bit mask denotes which of the radio access technologies are set

struct telux::tel::OperatorStatus

Defines status of network operator

Data Fields
InUseStatus	inUse	In-use status of network operator
RoamingStatus	roaming	Roaming status of network operator
ForbiddenStatus	forbidden	Forbidden status of network operator
PreferredStatus	preferred	Preferred status of network operator

class telux::tel::INetworkSelectionManager

Network Selection Manager class provides the interface to get and set network selection mode, preferred network list and scan available networks.

Public Member Functions
virtual bool	isSubsystemReady ()=0

virtual std::future< bool >	onSubsystemReady ()=0

virtual telux::common::Status	requestNetworkSelectionMode (SelectionModeResponseCallback callback)=0

virtual telux::common::Status	setNetworkSelectionMode (NetworkSelectionMode selectMode, std::string mcc, std::string mnc, common::ResponseCallback callback=nullptr)=0

virtual telux::common::Status	requestPreferredNetworks (PreferredNetworksCallback callback)=0

virtual telux::common::Status	setPreferredNetworks (std::vector< PreferredNetworkInfo > preferredNetworksInfo, bool clearPrevious, common::ResponseCallback callback=nullptr)=0

virtual telux::common::Status	performNetworkScan (NetworkScanCallback callback)=0

virtual telux::common::Status	performNetworkScan (common::ResponseCallback callback=nullptr)=0

virtual telux::common::Status	registerListener (std::weak_ptr< INetworkSelectionListener > listener)=0

virtual telux::common::Status	deregisterListener (std::weak_ptr< INetworkSelectionListener > listener)=0

virtual	~INetworkSelectionManager ()

Constructor & Destructor Documentation

virtual telux::tel::INetworkSelectionManager::~INetworkSelectionManager ( )

virtual

Member Function Documentation

virtual bool telux::tel::INetworkSelectionManager::isSubsystemReady ( )

pure virtual

Checks the status of network subsystem and returns the result.

Returns: True if network subsystem is ready for service otherwise false.

virtual std::future<bool> telux::tel::INetworkSelectionManager::onSubsystemReady ( )

pure virtual

Wait for network subsystem to be ready.

Returns: A future that caller can wait on to be notified when network subsystem is ready.

virtual telux::common::Status telux::tel::INetworkSelectionManager::requestNetworkSelectionMode ( SelectionModeResponseCallback callback )

pure virtual

Get current network selection mode (i.e Manual or Automatic) asynchronously.

Parameters

[in] callback Callback function to get the response of get network selection mode request.

Returns: Status of requestNetworkSelectionMode i.e. success or suitable error code.

virtual telux::common::Status telux::tel::INetworkSelectionManager::setNetworkSelectionMode	(	NetworkSelectionMode	selectMode,
		std::string	mcc,
		std::string	mnc,
		common::ResponseCallback	callback = `nullptr`
	)

pure virtual

Set current network selection mode and receive the response asynchronously.

Parameters

[in]	selectMode	Selection mode for a network i.e. automatic or manual. If selection mode is automatic then MCC and MNC are ignored. If it is manual, client has to explicitly pass MCC and MNC as arguments.
[in]	callback	Optional callback function to get the response of set network selection mode request.
[in]	mcc	Mobile Country Code (Applicable only for MANUAL selection mode).
[in]	mnc	Mobile Network Code (Applicable only for MANUAL selection mode).

Returns: Status of setNetworkSelectionMode i.e. success or suitable error code.

virtual telux::common::Status telux::tel::INetworkSelectionManager::requestPreferredNetworks ( PreferredNetworksCallback callback )

pure virtual

Get 3GPP preferred network list and static 3GPP preferred network list asynchronously. Higher priority networks appear first in the list. The networks that appear in the 3GPP Preferred Networks list get higher priority than the networks in the static 3GPP preferred networks list.

Parameters

[in] callback Callback function to get the response of get preferred networks request.

Returns: Status of requestPreferredNetworks i.e. success or suitable error code.

virtual telux::common::Status telux::tel::INetworkSelectionManager::setPreferredNetworks	(	std::vector< PreferredNetworkInfo >	preferredNetworksInfo,
		bool	clearPrevious,
		common::ResponseCallback	callback = `nullptr`
	)

pure virtual

Set 3GPP preferred network list and receive the response asynchronously. It overrides the existing preferred network list. The preferred network list affects network selection selection when automatic registration is performed by the device. Higher priority networks should appear first in the list.

Parameters

[in]	preferredNetworksInfo	List of 3GPP preferred networks.
[in]	clearPrevious	If flag is false then new 3GPP preferred network list is appended to existing preferred network list. If flag is true then old list is flushed and new 3GPP preferred network list is added.
[in]	callback	Callback function to get the response of set preferred network list request.

Returns: Status of setPreferredNetworks i.e. success or suitable error code.

virtual telux::common::Status telux::tel::INetworkSelectionManager::performNetworkScan ( NetworkScanCallback callback )

pure virtual

Perform the network scan and returns a list of available networks.

Parameters

[in] callback Callback function to get the response of perform network scan request

Returns: Status of performNetworkScan i.e. success or suitable error code.

Deprecated:: Use INetworkSelectionManager::performNetworkScan( common::ResponseCallback callback) API instead

virtual telux::common::Status telux::tel::INetworkSelectionManager::performNetworkScan ( common::ResponseCallback callback = nullptr )

pure virtual

Perform the network scan. The available networks list is returned incrementally as they become available, without waiting for the entire scan to complete through the indication API (INetworkSelectionListener::onNetworkScanResults). The scan status in indication will indicate if its a partial result or complete result.

Parameters

[in] callback Callback function to get the response of network scan request

Returns: Status of performNetworkScan i.e. success or suitable error code.

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

virtual telux::common::Status telux::tel::INetworkSelectionManager::registerListener ( std::weak_ptr< INetworkSelectionListener > listener )

pure virtual

Register a listener for specific updates from network access service.

Parameters

[in] listener Pointer of INetworkSelectionListener object that processes the notification

Returns: Status of registerListener i.e success or suitable status code.

virtual telux::common::Status telux::tel::INetworkSelectionManager::deregisterListener ( std::weak_ptr< INetworkSelectionListener > listener )

pure virtual

Deregister the previously added listener.

Parameters

[in] listener Previously registered INetworkSelectionListener that needs to be removed

Returns: Status of removeListener success or suitable status code

class telux::tel::OperatorInfo

Operator Info class provides operator name, MCC, MNC and network status.

Public Member Functions
	OperatorInfo (std::string networkName, std::string mcc, std::string mnc, OperatorStatus operatorStatus)

	OperatorInfo (std::string networkName, std::string mcc, std::string mnc, RadioTechnology rat, OperatorStatus operatorStatus)

std::string	getName ()

std::string	getMcc ()

std::string	getMnc ()

RadioTechnology	getRat ()

OperatorStatus	getStatus ()

Constructor & Destructor Documentation

telux::tel::OperatorInfo::OperatorInfo	(	std::string	networkName,
		std::string	mcc,
		std::string	mnc,
		OperatorStatus	operatorStatus
	)

telux::tel::OperatorInfo::OperatorInfo	(	std::string	networkName,
		std::string	mcc,
		std::string	mnc,
		RadioTechnology	rat,
		OperatorStatus	operatorStatus
	)

Member Function Documentation

std::string telux::tel::OperatorInfo::getName ( )

Get Operator name or description

Returns: Operator name.

std::string telux::tel::OperatorInfo::getMcc ( )

Get mcc from the operator numeric.

Returns: MCC.

std::string telux::tel::OperatorInfo::getMnc ( )

Get mnc from operator numeric.

Returns: MNC.

RadioTechnology telux::tel::OperatorInfo::getRat ( )

Get radio access technology.

Returns: Radio access technology(RAT) RadioTechnology.

OperatorStatus telux::tel::OperatorInfo::getStatus ( )

Get status of operator.

Returns: status of the operator OperatorStatus.

class telux::tel::INetworkSelectionListener

Listener class for getting network selection mode change notification.

The methods in listener can be invoked from multiple different threads. Client needs to make sure that implementation is thread-safe.

Public Member Functions
virtual void	onSelectionModeChanged (NetworkSelectionMode mode)

virtual void	onNetworkScanResults (NetworkScanStatus scanStatus, std::vector< telux::tel::OperatorInfo > operatorInfos)

virtual	~INetworkSelectionListener ()

Public Member Functions inherited from telux::common::IServiceStatusListener
virtual void	onServiceStatusChange (ServiceStatus status)

virtual	~IServiceStatusListener ()

Constructor & Destructor Documentation

virtual telux::tel::INetworkSelectionListener::~INetworkSelectionListener ( )

virtual

Destructor of INetworkSelectionListener

Member Function Documentation

virtual void telux::tel::INetworkSelectionListener::onSelectionModeChanged ( NetworkSelectionMode mode )

virtual

This function is called whenever network selection mode is changed.

Parameters

[in] mode Network selection mode NetworkSelectionMode

virtual void telux::tel::INetworkSelectionListener::onNetworkScanResults	(	NetworkScanStatus	scanStatus,
		std::vector< telux::tel::OperatorInfo >	operatorInfos
	)

virtual

This function is called in response to performNetworkScan API. This API will be invoked multiple times in case of partial network scan results. In case of network scan failure and network scan completed this API will not be invoked further.

Parameters

[in]	scanStatus	Status of the network scan results NetworkScanStatus
[in]	operatorInfos	Operators info with details of network operator name, MCC, MNC, etc. In case of partial network scan results, the operator info will have the information of the new set of operator info along with previous partial network scan results.

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

Enumeration Type Documentation

enum telux::tel::RatType

Defines network RAT type for preferred networks. Each value represents corresponding bit for RatMask bitset.

Enumerator
UMTS	UMTS
LTE	LTE
LTE
GSM	GSM
GSM
NR5G	NR5G

enum telux::tel::NetworkScanStatus

strong

Defines the status of the network scan results

Enumerator
COMPLETE	Network scan is successful and completed. No more indications are expected for the scan request
PARTIAL	Network scan results are partial, further results are expected in subsequent indication
FAILED	Network scan failed either due to radio link failure or it is aborted or due to problem in performing incremental search.

enum telux::tel::NetworkSelectionMode

strong

Defines network selection mode

Enumerator
UNKNOWN	Unknown
AUTOMATIC	Device registers according to provisioned mcc and mnc
MANUAL	Device registers to specified network as per provided mcc and mnc

enum telux::tel::InUseStatus

strong

Defines in-use status of network operator

Enumerator
UNKNOWN	Unknown
CURRENT_SERVING	Current serving
AVAILABLE	Available

enum telux::tel::RoamingStatus

strong

Defines roaming status of network operator

Enumerator
UNKNOWN	Unknown
HOME	Home
ROAM	Roaming

enum telux::tel::ForbiddenStatus

strong

Defines forbidden status of network operator

Enumerator
UNKNOWN	Unknown
FORBIDDEN	Forbidden
NOT_FORBIDDEN	Not forbidden

enum telux::tel::PreferredStatus

strong

Defines preferred status of network operator

Enumerator
UNKNOWN	Unknown
PREFERRED	Preferred
NOT_PREFERRED	Not preferred

Data Structures

Enumerations

Detailed Description

Data Structure Documentation

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Enumeration Type Documentation