ubuntu-location-service
..
An aggregating location service providing positioning and geocoding capabilities to applications.
|
The Manager class encapsulates access to network/radio information. More...
#include <manager.h>
Classes | |
struct | Errors |
Public Member Functions | |
virtual const core::Property< State > & | state () const =0 |
Returns the getable/observable connectivity state of the system. More... | |
virtual const core::Property< bool > & | is_wifi_enabled () const =0 |
Returns a getable/observable boolean property that indicates the state of the wifi subsystem. More... | |
virtual const core::Property< bool > & | is_wwan_enabled () const =0 |
Returns a getable/observable boolean property that indicates the state of the wwan subsystem. More... | |
virtual const core::Property< bool > & | is_wifi_hardware_enabled () const =0 |
Returns a getable/observable boolean property that indicates the state of the wifi hardware. More... | |
virtual const core::Property< bool > & | is_wwan_hardware_enabled () const =0 |
Returns a getable/observable boolean property that indicates the state of the wwan hardware. More... | |
virtual const core::Property< Characteristics > & | active_connection_characteristics () const =0 |
Returns a getable/observable property that describes the characteristics of the active network connection. More... | |
virtual void | request_scan_for_wireless_networks ()=0 |
request_scan_for_wireless_networks schedules a scan for visible wireless networks. More... | |
virtual const core::Signal & | wireless_network_scan_finished () const =0 |
wireless_network_scan_finished is emitted when a scan for wireless networks ends. More... | |
virtual const core::Signal< WirelessNetwork::Ptr > & | wireless_network_added () const =0 |
wireless_network_added is emitted whenever a new wifi becomes visible. More... | |
virtual const core::Signal< WirelessNetwork::Ptr > & | wireless_network_removed () const =0 |
wireless_network_removed is emitted whenever a wifi disappears. More... | |
virtual void | enumerate_visible_wireless_networks (const std::function< void(const WirelessNetwork::Ptr &)> &) const =0 |
Enumerates all wireless networks visible to the device. More... | |
virtual const core::Signal< RadioCell::Ptr > & | connected_cell_added () const =0 |
connected_cell_added is emitted whenever the underlying modem connects to a new cell. More... | |
virtual const core::Signal< RadioCell::Ptr > & | connected_cell_removed () const =0 |
connected_cell_removed is emitted whenever the underlying modem disconnects from a cell. More... | |
virtual void | enumerate_connected_radio_cells (const std::function< void(const RadioCell::Ptr &)> &) const =0 |
Enumerates all radio cells that the device is connected to. More... | |
Protected Member Functions | |
Manager ()=default | |
The Manager class encapsulates access to network/radio information.
|
protecteddefault |
|
pure virtual |
Returns a getable/observable property that describes the characteristics of the active network connection.
|
pure virtual |
connected_cell_added is emitted whenever the underlying modem connects to a new cell.
|
pure virtual |
connected_cell_removed is emitted whenever the underlying modem disconnects from a cell.
|
pure virtual |
Enumerates all radio cells that the device is connected to.
|
pure virtual |
Enumerates all wireless networks visible to the device.
|
pure virtual |
Returns a getable/observable boolean property that indicates the state of the wifi subsystem.
If the property's value is false, the Wifi subsystem is turned off (e.g., in flight mode).
|
pure virtual |
Returns a getable/observable boolean property that indicates the state of the wifi hardware.
If the property's value is false, the Wifi HW is turned off.
|
pure virtual |
Returns a getable/observable boolean property that indicates the state of the wwan subsystem.
If the property's value is false, the WWan subsystem is turned off (e.g., in flight mode).
|
pure virtual |
Returns a getable/observable boolean property that indicates the state of the wwan hardware.
If the property's value is false, the WWan HW is turned off.
|
pure virtual |
request_scan_for_wireless_networks schedules a scan for visible wireless networks.
std::runtime_error | to indicate issues arising from the underlying networking stack. |
Please note that the implementation is required to operate asynchronously. Results of the scan are reported via emitting the changed() signal on the visible_wireless_networks() property.
Please also note that calling this function is usually not required. The underlying networking stack is updating the list of available wireless networks very frequently. In addition, the results from scans requested by other system components are reported to consumers of this API, too.
|
pure virtual |
Returns the getable/observable connectivity state of the system.
|
pure virtual |
wireless_network_added is emitted whenever a new wifi becomes visible.
|
pure virtual |
wireless_network_removed is emitted whenever a wifi disappears.
|
pure virtual |
wireless_network_scan_finished is emitted when a scan for wireless networks ends.
Please note that the signal may also be raised for scans that have been initiated by other system components.