libsolidcontrol
Solid::Control::NetworkInterface Class Reference
#include <networkinterface.h>

Detailed Description
This interface represents a generic network interface in the system.Definition at line 41 of file networkinterface.h.
Member Enumeration Documentation
Possible Device capabilities
- IsManageable: denotes that the device can be controlled by this API
- SupportsCarrierDetect: the device informs us when it is plugged in to the medium
- SupportsWirelessScan: the device can scan for wireless networks.
Reimplemented in Solid::Control::WirelessNetworkInterface.
Definition at line 64 of file networkinterface.h.
Device connection states describe the possible states of a network connection from the user's point of view.
For simplicity, states from several different layers are present - this is a high level view
- Enumerator:
-
UnknownState Unmanaged Unavailable Disconnected Preparing Configuring NeedAuth IPConfig Activated Failed
Definition at line 56 of file networkinterface.h.
Device medium types
- Ieee8023: wired ethernet
- Ieee80211: the popular family of wireless networks
- Gsm: cellular device of the GSM family, used in Europe
- Cdma: cellular device of the CDMA family, used in the USA.
Definition at line 72 of file networkinterface.h.
Constructor & Destructor Documentation
Solid::Control::NetworkInterface::NetworkInterface | ( | QObject * | backendObject | ) | [explicit] |
Creates a new NetworkInterface object.
- Parameters:
-
backendObject the network object provided by the backend
Definition at line 27 of file networkinterface.cpp.
Solid::Control::NetworkInterface::NetworkInterface | ( | const NetworkInterface & | network | ) |
Constructs a copy of a network.
- Parameters:
-
network the network to copy
Definition at line 34 of file networkinterface.cpp.
Solid::Control::NetworkInterface::~NetworkInterface | ( | ) | [virtual] |
Solid::Control::NetworkInterface::NetworkInterface | ( | NetworkInterfacePrivate & | dd, | |
QObject * | backendObject | |||
) | [protected] |
Definition at line 41 of file networkinterface.cpp.
Solid::Control::NetworkInterface::NetworkInterface | ( | NetworkInterfacePrivate & | dd, | |
const NetworkInterface & | network | |||
) | [protected] |
Definition at line 47 of file networkinterface.cpp.
Member Function Documentation
Solid::Control::NetworkInterface::Capabilities Solid::Control::NetworkInterface::capabilities | ( | ) | const |
Retrieves the capabilities supported by this device.
- Returns:
- the capabilities of the device
Definition at line 105 of file networkinterface.cpp.
Solid::Control::NetworkInterface::ConnectionState Solid::Control::NetworkInterface::connectionState | ( | ) | const |
Retrieves the current state of the network connection held by this device.
It's a high level view of the connection. It is user oriented, so actually it provides state coming from different layers.
- Returns:
- the current connection state
Definition at line 93 of file networkinterface.cpp.
void Solid::Control::NetworkInterface::connectionStateChanged | ( | int | state | ) | [signal] |
This signal is emitted when the device's link status changed.
For example, if there is no carrier anymore.
- Parameters:
-
state the new state of the connection
int Solid::Control::NetworkInterface::designSpeed | ( | ) | const |
Retrieves the maximum speed as reported by the device.
Note that this is only a design related piece of information, and that the device might not reach this maximum.
- Returns:
- the device's maximum speed
Definition at line 99 of file networkinterface.cpp.
QString Solid::Control::NetworkInterface::driver | ( | ) | const |
Handle for the system driver controlling this network interface.
Definition at line 75 of file networkinterface.cpp.
QString Solid::Control::NetworkInterface::interfaceName | ( | ) | const |
void Solid::Control::NetworkInterface::ipDetailsChanged | ( | ) | [signal] |
This signal is emitted when the settings of this network have changed.
Solid::Control::IPv4Config Solid::Control::NetworkInterface::ipV4Config | ( | ) | const |
Definition at line 81 of file networkinterface.cpp.
bool Solid::Control::NetworkInterface::isActive | ( | ) | const |
Retrieves the activation status of this network interface.
- Returns:
- true if this network interface is active, false otherwise
Definition at line 87 of file networkinterface.cpp.
void Solid::Control::NetworkInterface::linkUpChanged | ( | bool | linkActivated | ) | [signal] |
This signal is emitted when the device's link status changed.
For example, if there is no carrier anymore.
- Parameters:
-
linkActivated true if the carrier got detected, false otherwise
Solid::Control::NetworkInterface::Type Solid::Control::NetworkInterface::type | ( | ) | const [virtual] |
Retrieves the interface type.
This is a virtual function that will return the proper type of all sub-classes.
- Returns:
- the NetworkInterface::Type that corresponds to this device.
Reimplemented in Solid::Control::CdmaNetworkInterface, Solid::Control::GsmNetworkInterface, Solid::Control::SerialNetworkInterface, Solid::Control::WiredNetworkInterface, and Solid::Control::WirelessNetworkInterface.
Definition at line 58 of file networkinterface.cpp.
QString Solid::Control::NetworkInterface::uni | ( | ) | const |
Retrieves the Unique Network Identifier (UNI) of the NetworkInterface.
This identifier is unique for each network and network interface in the system.
- Returns:
- the Unique Network Identifier of the current network
Definition at line 63 of file networkinterface.cpp.
Member Data Documentation
NetworkInterfacePrivate* Solid::Control::NetworkInterface::d_ptr [protected] |
Definition at line 189 of file networkinterface.h.
The documentation for this class was generated from the following files: