Telematics_wlan_station

Modules
	Telematics_wlan

Data Structures
struct	telux::wlan::StaStaticIpConfig
struct	telux::wlan::StaConfig

Enumerations
enum	telux::wlan::StaIpConfig { telux::wlan::StaIpConfig::DYNAMIC_IP = 1, telux::wlan::StaIpConfig::STATIC_IP = 2 }
enum	telux::wlan::StaBridgeMode { telux::wlan::StaBridgeMode::ROUTER = 0, telux::wlan::StaBridgeMode::BRIDGE = 1 }

Functions
virtual telux::common::ErrorCode	telux::wlan::IStaInterfaceManager::setIpConfig (Id staId, StaIpConfig ipConfig, StaStaticIpConfig staticIpConfig)=0
virtual telux::common::ErrorCode	telux::wlan::IStaInterfaceManager::setBridgeMode (Id staId, StaBridgeMode bridgeMode)=0
virtual telux::common::ErrorCode	telux::wlan::IStaInterfaceManager::getConfig (std::vector< StaConfig > &config)=0
virtual telux::common::ErrorCode	telux::wlan::IStaInterfaceManager::getStatus (std::vector< StaStatus > &status)=0
virtual telux::common::ErrorCode	telux::wlan::IStaInterfaceManager::manageStaService (Id staId, ServiceOperation opr)=0
virtual telux::common::ErrorCode	telux::wlan::IStaInterfaceManager::registerListener (std::weak_ptr< IStaListener > listener)=0
virtual telux::common::ErrorCode	telux::wlan::IStaInterfaceManager::deregisterListener (std::weak_ptr< IStaListener > listener)=0
virtual	telux::wlan::IStaInterfaceManager::~IStaInterfaceManager ()
virtual void	telux::wlan::IStaListener::onStationStatusChanged (std::vector< StaStatus > staStatus)
virtual void	telux::wlan::IStaListener::onStationBandChanged (BandType radio)
virtual	telux::wlan::IStaListener::~IStaListener ()

Variables
std::string	telux::wlan::StaStaticIpConfig::ipAddr
std::string	telux::wlan::StaStaticIpConfig::gwIpAddr
std::string	telux::wlan::StaStaticIpConfig::netMask
std::string	telux::wlan::StaStaticIpConfig::dnsAddr
Id	telux::wlan::StaConfig::staId
StaIpConfig	telux::wlan::StaConfig::ipConfig
StaStaticIpConfig	telux::wlan::StaConfig::staticIpConfig
StaBridgeMode	telux::wlan::StaConfig::bridgeMode

Detailed Description

---

Data Structure Documentation

struct telux::wlan::StaStaticIpConfig

Static IP Configuration

Data Fields
string	ipAddr	IPv4 address to be assigned.
string	gwIpAddr	IPv4 address of the gateway.
string	netMask	Subnet mask.
string	dnsAddr	DNS IPv4 address.

struct telux::wlan::StaConfig

Station Configuration

Data Fields
Id	staId	Id of station backhaul
StaIpConfig	ipConfig	IP configuration of station backhaul
StaStaticIpConfig	staticIpConfig	Static IP configuration if selected
StaBridgeMode	bridgeMode	Station configuration as Router/bridge

Enumeration Type Documentation

enum telux::wlan::StaIpConfig

strong

Station Connection IP Type

Enumerator
DYNAMIC_IP	Station is configured with dynamic IP
STATIC_IP	Station is configured with Static IP

enum telux::wlan::StaBridgeMode

strong

Bridge/Router Mode

Enumerator
ROUTER	Station is in Router Mode
BRIDGE	Station is in Bridge Mode

Function Documentation

virtual telux::common::ErrorCode telux::wlan::IStaInterfaceManager::setIpConfig ( Id  staId, StaIpConfig  ipConfig, StaStaticIpConfig  staticIpConfig  )

pure virtual

Set Station IP Configurations: Set Station IP configuration dynamic/static and static IP address if selected. If API is called when WLAN is disabled, changes will take effect when WLAN is enabled using telux::wlan::IWlanDeviceManager::enable API. If API is called when WLAN is enabled, changes will take effect after restarting wpa_supplicant by calling telux::wlan::IStaInterfaceManager::manageStaService

Parameters

[in]	staId	Station Identifier telux::wlan::Id
[in]	ipConfig	Static/Dynamic IP configuration telux::wlan::StaIpConfig.
[in]	staticIpConfig	Static IP configuration, not used if station was configured to use dynamic IP.

On platforms with Access control enabled, Caller needs to have TELUX_WLAN_STA_CONFIG permission to invoke this API successfully.

Returns

operation error code (if any). telux::common::ErrorCode.

Note

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

virtual telux::common::ErrorCode telux::wlan::IStaInterfaceManager::setBridgeMode ( Id  staId, StaBridgeMode  bridgeMode  )

pure virtual

Set Station backhaul to act as router or bridge: Sets Station to act as router or bridge where station internal clients get public IP addresses. If API is called when WLAN is disabled, changes will take effect when WLAN is enabled using telux::wlan::IWlanDeviceManager::enable API. If API is called when WLAN is enabled, changes will take effect after restarting wpa_supplicant by calling telux::wlan::IStaInterfaceManager::manageStaService

On platforms with Access control enabled, Caller needs to have TELUX_WLAN_STA_CONFIG permission to invoke this API successfully.

Parameters

[in]	staId	Station Identifier telux::wlan::Id
[in]	bridgeMode	bridgeMode telux::wlan::StaBridgeMode

Returns

operation error code (if any). telux::common::ErrorCode.

Note

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

virtual telux::common::ErrorCode telux::wlan::IStaInterfaceManager::getConfig ( std::vector< StaConfig > &  config )

pure virtual

Request current station configurations: Returns configurations set by telux::wlan::IStaInterfaceManager::setIpConfig and telux::wlan::IStaInterfaceManager::setBridgeMode

Parameters

[in]

config

Station configurations telux::wlan::StaConfig

Returns

operation error code (if any). telux::common::ErrorCode.

Note

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

virtual telux::common::ErrorCode telux::wlan::IStaInterfaceManager::getStatus ( std::vector< StaStatus > &  status )

pure virtual

Request current station status: Returns current Sta interface status such as network interface name and IP address.

Parameters

[in]

status

Station Status telux::wlan::StaStatus

Returns

operation error code (if any). telux::common::ErrorCode.

Note

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

virtual telux::common::ErrorCode telux::wlan::IStaInterfaceManager::manageStaService ( Id  staId, ServiceOperation  opr  )

pure virtual

Execute an operation on wpa_supplicant service. Provides ability for client to either stop/start or restart wpa_supplicant service for selected station. Restarting wpa_supplicant service is required for any changes made to wpa_supplicant.conf file to take effect. Station selected to execute operation on, will temporarily go out of service when this API is called. This API should be called only when station mode is configured through telux::wlan::IDeviceManager::setMode

On platforms with Access control enabled, Caller needs to have TELUX_WLAN_STA_CONFIG permission to invoke this API successfully.

Parameters

[in]	staId	Station identifier to execute operation on. telux::wlan::Id
[in]	opr	Operation to be performed on wpa_supplicant telux::wlan::ServiceOperation

Returns

operation error code (if any). telux::common::ErrorCode.

Note

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

virtual telux::common::ErrorCode telux::wlan::IStaInterfaceManager::registerListener ( std::weak_ptr< IStaListener >  listener )

pure virtual

Register as a listener for specific events defined in telux::wlan::IStaListener

Parameters

[in]

listener

pointer of IStaListener object that processes the notification

Returns

operation error code (if any). telux::common::ErrorCode.

virtual telux::common::ErrorCode telux::wlan::IStaInterfaceManager::deregisterListener ( std::weak_ptr< IStaListener >  listener )

pure virtual

Removes a previously added listener.

Parameters

[in]

listener

pointer of IStaListener object that needs to be removed

Returns

operation error code (if any). telux::common::ErrorCode.

virtual telux::wlan::IStaInterfaceManager::~IStaInterfaceManager ( )

virtual

virtual void telux::wlan::IStaListener::onStationStatusChanged ( std::vector< StaStatus >  staStatus )

virtual

This function is called when Station Status Changes

Parameters

[in]

status

List of station state telux::wlan::StaStatus

virtual void telux::wlan::IStaListener::onStationBandChanged ( BandType  radio )

virtual

This function is called when Station switch to different operation band

Parameters

[in]

radio

New Station operation band telux::wlan::BandType

virtual telux::wlan::IStaListener::~IStaListener ( )

virtual

Variable Documentation

std::string telux::wlan::StaStaticIpConfig::ipAddr

IPv4 address to be assigned.

std::string telux::wlan::StaStaticIpConfig::gwIpAddr

IPv4 address of the gateway.

std::string telux::wlan::StaStaticIpConfig::netMask

Subnet mask.

std::string telux::wlan::StaStaticIpConfig::dnsAddr

DNS IPv4 address.

Id telux::wlan::StaConfig::staId

Id of station backhaul

StaIpConfig telux::wlan::StaConfig::ipConfig

IP configuration of station backhaul

StaStaticIpConfig telux::wlan::StaConfig::staticIpConfig

Static IP configuration if selected

StaBridgeMode telux::wlan::StaConfig::bridgeMode

Station configuration as Router/bridge