• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

libsolidcontrol

Solid::Control::NetworkManager

Solid::Control::NetworkManager Namespace Reference

This class allow to query the underlying system to discover the available network interfaces and reachable network.It has also the responsibility to notify when a network interface or a network appear or disappear. More...


Classes

class  Notifier

Functions

SOLIDCONTROL_EXPORT void activateConnection (const QString &deviceUni, const QString &connectionUni, const QVariantMap &connectionParameters)
QStringList SOLIDCONTROL_EXPORT activeConnections ()
SOLIDCONTROL_EXPORT void deactivateConnection (const QString &activeConnectionUni)
SOLIDCONTROL_EXPORT
NetworkInterface * 
findNetworkInterface (const QString &uni)
SOLIDCONTROL_EXPORT bool isNetworkingEnabled ()
SOLIDCONTROL_EXPORT bool isWirelessEnabled ()
SOLIDCONTROL_EXPORT bool isWirelessHardwareEnabled ()
SOLIDCONTROL_EXPORT
NetworkInterfaceList 
networkInterfaces ()
SOLIDCONTROL_EXPORT Notifier * notifier ()
SOLIDCONTROL_EXPORT void setNetworkingEnabled (bool enabled)
SOLIDCONTROL_EXPORT void setWirelessEnabled (bool enabled)
SOLIDCONTROL_EXPORT
Solid::Networking::Status 
status ()

Detailed Description

This class allow to query the underlying system to discover the available network interfaces and reachable network.It has also the responsibility to notify when a network interface or a network appear or disappear.

It's the unique entry point for network management. Applications should use it to find network interfaces, or to be notified about network related changes.

Note that it's implemented as a singleton and encapsulates the backend logic.


Function Documentation

void Solid::Control::NetworkManager::activateConnection ( const QString &  deviceUni,
const QString &  connectionUni,
const QVariantMap &  connectionParameters 
)

Parameters:
deviceUni unique identifier of the network interface to be activated
connectionUni unique identifier for the connection to be activated
connectionParameters can be used to specify extra parameters not specific to the NetworkInterface or the connection, eg which AP to use when several present with same ESSID in range (because ESSID no guarantee that the AP is part of the network you want to join!)

Definition at line 259 of file networkmanager.cpp.

QStringList Solid::Control::NetworkManager::activeConnections (  ) 

Access the list of any active connections.

Definition at line 270 of file networkmanager.cpp.

void Solid::Control::NetworkManager::deactivateConnection ( const QString &  activeConnectionUni  ) 

Deactivate this network interface, if active.

Parameters:
activeConnectionUni identifer of the connection to deactivate

Definition at line 265 of file networkmanager.cpp.

Solid::Control::NetworkInterface * Solid::Control::NetworkManager::findNetworkInterface ( const QString &  uni  ) 

Find a new NetworkInterface object given its UNI.

This pointer is owned by the Solid infrastructure.

Parameters:
uni the identifier of the network interface to find
Returns:
a valid NetworkInterface object if there's a device having the given UNI, an invalid one otherwise

Definition at line 164 of file networkmanager.cpp.

bool Solid::Control::NetworkManager::isNetworkingEnabled (  ) 

Retrieves the status of networking (as a whole) in the system.

This is distinct from whether the system's networking is online or offline. To check that, see NetworkStatus.

Returns:
true if this networking is enabled, false otherwise

Definition at line 116 of file networkmanager.cpp.

bool Solid::Control::NetworkManager::isWirelessEnabled (  ) 

Retrieves the activation status of wireless networking in the system.

Returns:
true if this wireless networking is enabled, false otherwise

Definition at line 121 of file networkmanager.cpp.

bool Solid::Control::NetworkManager::isWirelessHardwareEnabled (  ) 

Retrieves the status of wireless hardware in the system.

This is typically controlled by a physical switch so there is no way to set this in software.

Since:
KDE 4.1
Returns:
true if this wireless networking is enabled, false otherwise

Definition at line 126 of file networkmanager.cpp.

Solid::Control::NetworkInterfaceList Solid::Control::NetworkManager::networkInterfaces (  ) 

Retrieves the list of all the network interfaces in the system.

It includes both hardware and virtual devices.

Returns:
the list of network interfaces available in this system

Definition at line 111 of file networkmanager.cpp.

Solid::Control::NetworkManager::Notifier * Solid::Control::NetworkManager::notifier (  ) 

Definition at line 169 of file networkmanager.cpp.

void Solid::Control::NetworkManager::setNetworkingEnabled ( bool  enabled  ) 

Activates or deactivates networking (as a whole).

Parameters:
enabled true to activate networking, false otherwise

Definition at line 131 of file networkmanager.cpp.

void Solid::Control::NetworkManager::setWirelessEnabled ( bool  enabled  ) 

Activates or deactivates wireless networking.

Parameters:
enabled true to activate wireless networking, false otherwise

Definition at line 136 of file networkmanager.cpp.

Solid::Networking::Status Solid::Control::NetworkManager::status (  ) 

Get the manager connection state.

Definition at line 141 of file networkmanager.cpp.

libsolidcontrol

Skip menu "libsolidcontrol"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • KWin
  •   KWin Libraries
  • Libraries
  •   libkworkspace
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal