NetworkManager::Device

Search for usage in LXR

#include <device.h>

Inheritance diagram for NetworkManager::Device:

Public Types

typedef QFlags< CapabilityCapabilities
 
enum  Capability { IsManageable = 0x1 , SupportsCarrierDetect = 0x2 }
 
enum  Interfaceflag { None = NM_DEVICE_INTERFACE_FLAG_NONE , Up = NM_DEVICE_INTERFACE_FLAG_UP , LowerUp = NM_DEVICE_INTERFACE_FLAG_LOWER_UP , Carrier = NM_DEVICE_INTERFACE_FLAG_CARRIER }
 
typedef QFlags< InterfaceflagInterfaceflags
 
typedef QList< PtrList
 
enum  MeteredStatus {
  UnknownStatus = 0 , Yes = 1 , No = 2 , GuessYes = 3 ,
  GuessNo = 4
}
 
typedef QSharedPointer< DevicePtr
 
enum  State {
  UnknownState = 0 , Unmanaged = 10 , Unavailable = 20 , Disconnected = 30 ,
  Preparing = 40 , ConfiguringHardware = 50 , NeedAuth = 60 , ConfiguringIp = 70 ,
  CheckingIp = 80 , WaitingForSecondaries = 90 , Activated = 100 , Deactivating = 110 ,
  Failed = 120
}
 
enum  StateChangeReason {
  UnknownReason = 0 , NoReason = 1 , NowManagedReason = 2 , NowUnmanagedReason = 3 ,
  ConfigFailedReason = 4 , ConfigUnavailableReason = 5 , ConfigExpiredReason = 6 , NoSecretsReason = 7 ,
  AuthSupplicantDisconnectReason = 8 , AuthSupplicantConfigFailedReason = 9 , AuthSupplicantFailedReason = 10 , AuthSupplicantTimeoutReason = 11 ,
  PppStartFailedReason = 12 , PppDisconnectReason = 13 , PppFailedReason = 14 , DhcpStartFailedReason = 15 ,
  DhcpErrorReason = 16 , DhcpFailedReason = 17 , SharedStartFailedReason = 18 , SharedFailedReason = 19 ,
  AutoIpStartFailedReason = 20 , AutoIpErrorReason = 21 , AutoIpFailedReason = 22 , ModemBusyReason = 23 ,
  ModemNoDialToneReason = 24 , ModemNoCarrierReason = 25 , ModemDialTimeoutReason = 26 , ModemDialFailedReason = 27 ,
  ModemInitFailedReason = 28 , GsmApnSelectFailedReason = 29 , GsmNotSearchingReason = 30 , GsmRegistrationDeniedReason = 31 ,
  GsmRegistrationTimeoutReason = 32 , GsmRegistrationFailedReason = 33 , GsmPinCheckFailedReason = 34 , FirmwareMissingReason = 35 ,
  DeviceRemovedReason = 36 , SleepingReason = 37 , ConnectionRemovedReason = 38 , UserRequestedReason = 39 ,
  CarrierReason = 40 , ConnectionAssumedReason = 41 , SupplicantAvailableReason = 42 , ModemNotFoundReason = 43 ,
  BluetoothFailedReason = 44 , GsmSimNotInserted = 45 , GsmSimPinRequired = 46 , GsmSimPukRequired = 47 ,
  GsmSimWrong = 48 , InfiniBandMode = 49 , DependencyFailed = 50 , Br2684Failed = 51 ,
  ModemManagerUnavailable = 52 , SsidNotFound = 53 , SecondaryConnectionFailed = 54 , DcbFcoeFailed = 55 ,
  TeamdControlFailed = 56 , ModemFailed = 57 , ModemAvailable = 58 , SimPinIncorrect = 59 ,
  NewActivation = 60 , ParentChanged = 61 , ParentManagedChanged = 62 , Reserved = 65536
}
 
enum  Type {
  UnknownType = NM_DEVICE_TYPE_UNKNOWN , Ethernet = NM_DEVICE_TYPE_ETHERNET , Wifi = NM_DEVICE_TYPE_WIFI , Unused1 = NM_DEVICE_TYPE_UNUSED1 ,
  Unused2 = NM_DEVICE_TYPE_UNUSED2 , Bluetooth = NM_DEVICE_TYPE_BT , OlpcMesh = NM_DEVICE_TYPE_OLPC_MESH , Wimax = NM_DEVICE_TYPE_WIMAX ,
  Modem = NM_DEVICE_TYPE_MODEM , InfiniBand = NM_DEVICE_TYPE_INFINIBAND , Bond = NM_DEVICE_TYPE_BOND , Vlan = NM_DEVICE_TYPE_VLAN ,
  Adsl = NM_DEVICE_TYPE_ADSL , Bridge = NM_DEVICE_TYPE_BRIDGE , Generic = NM_DEVICE_TYPE_GENERIC , Team = NM_DEVICE_TYPE_TEAM ,
  Gre , MacVlan , Tun , Veth ,
  IpTunnel , VxLan , MacSec , Dummy ,
  Ppp , OvsInterface , OvsPort , OvsBridge ,
  Wpan , Lowpan , WireGuard , WifiP2P ,
  VRF , Loopback
}
 
typedef QFlags< TypeTypes
 
- Public Types inherited from QObject
typedef  QObjectList
 

Properties

bool autoconnect
 
NetworkManager::DeviceStatistics::Ptr deviceStatistics
 
QString driver
 
QString driverVersion
 
bool firmwareMissing
 
QString firmwareVersion
 
QVariant genericCapabilities
 
Interfaceflags InterfaceFlags
 
QString interfaceName
 
QString ipInterfaceName
 
QHostAddress ipV4Address
 
bool managed
 
MeteredStatus metered
 
uint mtu
 
bool nmPluginMissing
 
State state
 
DeviceStateReason stateReason
 
QString udi
 
QString uni
 
- Properties inherited from QObject
 objectName
 

Signals

void activeConnectionChanged ()
 
void autoconnectChanged ()
 
void availableConnectionAppeared (const QString &connection)
 
void availableConnectionChanged ()
 
void availableConnectionDisappeared (const QString &connection)
 
void capabilitiesChanged ()
 
void connectionStateChanged ()
 
void dhcp4ConfigChanged ()
 
void dhcp6ConfigChanged ()
 
void driverChanged ()
 
void driverVersionChanged ()
 
void firmwareMissingChanged ()
 
void firmwareVersionChanged ()
 
void interfaceFlagsChanged ()
 
void interfaceNameChanged ()
 
void ipInterfaceChanged ()
 
void ipV4AddressChanged ()
 
void ipV4ConfigChanged ()
 
void ipV6ConfigChanged ()
 
void managedChanged ()
 
void meteredChanged (MeteredStatus metered)
 
void mtuChanged ()
 
void nmPluginMissingChanged (bool nmPluginMissing)
 
void physicalPortIdChanged ()
 
void stateChanged (NetworkManager::Device::State newstate, NetworkManager::Device::State oldstate, NetworkManager::Device::StateChangeReason reason)
 
void stateReasonChanged ()
 
void udiChanged ()
 

Public Member Functions

 Device (const QString &path, QObject *parent=nullptr)
 
 ~Device () override
 
NetworkManager::ActiveConnection::Ptr activeConnection () const
 
template<class DevIface >
DevIface * as ()
 
template<class DevIface >
const DevIface * as () const
 
bool autoconnect () const
 
Connection::List availableConnections ()
 
Capabilities capabilities () const
 
QVariant capabilitiesV () const
 
QDBusPendingReply deleteInterface ()
 
int designSpeed () const
 
DeviceStatistics::Ptr deviceStatistics () const
 
Dhcp4Config::Ptr dhcp4Config () const
 
Dhcp6Config::Ptr dhcp6Config () const
 
QDBusPendingReply disconnectInterface ()
 
QString driver () const
 
QString driverVersion () const
 
bool firmwareMissing () const
 
QString firmwareVersion () const
 
Interfaceflags interfaceFlags () const
 
QString interfaceName () const
 
QString ipInterfaceName () const
 
QHostAddress ipV4Address () const
 
IpConfig ipV4Config () const
 
IpConfig ipV6Config () const
 
bool isActive () const
 
bool isValid () const
 
bool managed () const
 
MeteredStatus metered () const
 
uint mtu () const
 
bool nmPluginMissing () const
 
QString physicalPortId () const
 
QDBusPendingReply reapplyConnection (const NMVariantMapMap &connection, qulonglong version_id, uint flags)
 
void setAutoconnect (bool autoconnect)
 
State state () const
 
DeviceStateReason stateReason () const
 
virtual Type type () const
 
QString udi () const
 
QString uni () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Member Functions

NETWORKMANAGERQT_NO_EXPORT Device (DevicePrivate &dd, QObject *parent)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Protected Attributes

DevicePrivate *const d_ptr
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 

Detailed Description

This class represents a common device interface.

Definition at line 33 of file device.h.

Member Typedef Documentation

◆ Capabilities

◆ Interfaceflags

◆ List

Definition at line 59 of file device.h.

◆ Ptr

◆ Types

Definition at line 228 of file device.h.

Member Enumeration Documentation

◆ Capability

Possible device capabilities.

Enumerator
IsManageable 

denotes that the device can be controlled by this API

SupportsCarrierDetect 

the device informs us when it is plugged in to the medium

Definition at line 167 of file device.h.

◆ Interfaceflag

Possible device interfaceflags.

Enumerator
None 

no flags set

Up 

Corresponds to kernel IFF_UP.

LowerUp 

Corresponds to kernel IFF_LOWER_UP.

Carrier 

the interface has carrier

Definition at line 178 of file device.h.

◆ MeteredStatus

Enumerator
UnknownStatus 

The device metered status is unknown.

Yes 

The device is metered and the value was statically set.

No 

The device is not metered and the value was statically set.

GuessYes 

The device is metered and the value was guessed.

GuessNo 

The device is not metered and the value was guessed.

Definition at line 155 of file device.h.

◆ State

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 

The device is in an unknown state.

Unmanaged 

The device is recognized but not managed by NetworkManager.

Unavailable 

The device cannot be used (carrier off, rfkill, etc)

Disconnected 

The device is not connected.

Preparing 

The device is preparing to connect.

ConfiguringHardware 

The device is being configured.

NeedAuth 

The device is awaiting secrets necessary to continue connection.

ConfiguringIp 

The IP settings of the device are being requested and configured.

CheckingIp 

The device's IP connectivity ability is being determined.

WaitingForSecondaries 

The device is waiting for secondary connections to be activated.

Activated 

The device is active.

Deactivating 

The device's network connection is being torn down.

Failed 

The device is in a failure state following an attempt to activate it.

Definition at line 66 of file device.h.

◆ StateChangeReason

Enums describing the reason for a connection state change.

Note
StateChangeReasons NewActivation, ParentChanged, ParentManagedChanged are available in runtime NM >= 1.0.4

Definition at line 87 of file device.h.

◆ Type

Device type.

Enumerator
UnknownType 

Unknown device type.

Ethernet 

Ieee8023 wired ethernet.

Wifi 

the Ieee80211 family of wireless networks

Unused1 

Currently unused.

Unused2 

Currently unused.

Bluetooth 

network bluetooth device (usually a cell phone)

OlpcMesh 

OLPC Mesh networking device.

Wimax 

WiMax WWAN technology.

Modem 

POTS, GSM, CDMA or LTE modems.

InfiniBand 

Infiniband network device.

Bond 

Bond virtual device.

Vlan 

Vlan virtual device.

Adsl 

ADSL modem device.

Bridge 

Bridge virtual device.

Generic 

Generic device.

Since
1.0.0
Team 

Team master device.

Since
1.0.0
Gre 

Gre virtual device.

Since
1.2.0,
Deprecated
use IpTunnel instead
MacVlan 

MacVlan virtual device.

Since
1.2.0
Tun 

Tun virtual device.

Since
1.2.0
Veth 

Veth virtual device.

Since
1.2.0
IpTunnel 

IP Tunneling Device.

Since
1.2.0
VxLan 

Vxlan Device.

Since
1.2.0
MacSec 

MacSec Device.

Since
1.6.0
Dummy 

Dummy Device.

Since
1.8.0
Ppp 

Ppp Device.

Since
1.10
OvsInterface 

OvsInterface Device.

Since
1.10
OvsPort 

OvsPort Device.

Since
1.10
OvsBridge 

OvsBridge Device.

Since
1.10
Wpan 

Wpan Device.

Since
1.14
Lowpan 

Lowpan Device.

Since
1.14
WireGuard 

WireGuard Device.

Since
1.14
WifiP2P 

WifiP2P Device.

Since
1.16
VRF 

VRF (Virtual Routing and Forwarding) Device.

Since
: 1.24
Loopback 

Loopback Device.

Since
1.42

Definition at line 191 of file device.h.

Property Documentation

◆ autoconnect

bool NetworkManager::Device::autoconnect
readwrite

Definition at line 52 of file device.h.

◆ deviceStatistics

NetworkManager::DeviceStatistics::Ptr NetworkManager::Device::deviceStatistics
read

Definition at line 55 of file device.h.

◆ driver

QString NetworkManager::Device::driver
read

Definition at line 40 of file device.h.

◆ driverVersion

QString NetworkManager::Device::driverVersion
read

Definition at line 41 of file device.h.

◆ firmwareMissing

bool NetworkManager::Device::firmwareMissing
read

Definition at line 51 of file device.h.

◆ firmwareVersion

QString NetworkManager::Device::firmwareVersion
read

Definition at line 42 of file device.h.

◆ genericCapabilities

QVariant NetworkManager::Device::genericCapabilities
read

Definition at line 43 of file device.h.

◆ InterfaceFlags

Interfaceflags NetworkManager::Device::InterfaceFlags
read

Definition at line 47 of file device.h.

◆ interfaceName

QString NetworkManager::Device::interfaceName
read

Definition at line 38 of file device.h.

◆ ipInterfaceName

QString NetworkManager::Device::ipInterfaceName
read

Definition at line 39 of file device.h.

◆ ipV4Address

QHostAddress NetworkManager::Device::ipV4Address
read

Definition at line 44 of file device.h.

◆ managed

bool NetworkManager::Device::managed
read

Definition at line 45 of file device.h.

◆ metered

MeteredStatus NetworkManager::Device::metered
read

Definition at line 49 of file device.h.

◆ mtu

uint NetworkManager::Device::mtu
read

Definition at line 46 of file device.h.

◆ nmPluginMissing

bool NetworkManager::Device::nmPluginMissing
read

Definition at line 48 of file device.h.

◆ state

State NetworkManager::Device::state
read

Definition at line 54 of file device.h.

◆ stateReason

DeviceStateReason NetworkManager::Device::stateReason
read

Definition at line 53 of file device.h.

◆ udi

QString NetworkManager::Device::udi
read

Definition at line 50 of file device.h.

◆ uni

QString NetworkManager::Device::uni
read

Definition at line 37 of file device.h.

Constructor & Destructor Documentation

◆ Device() [1/2]

Device::Device ( const QString & path,
QObject * parent = nullptr )
explicit

Creates a new device object.

Parameters
pathUNI of the device

Definition at line 226 of file device.cpp.

◆ ~Device()

Device::~Device ( )
override

Destroys a device object.

Definition at line 379 of file device.cpp.

◆ Device() [2/2]

Device::Device ( DevicePrivate & dd,
QObject * parent )
protected

Definition at line 235 of file device.cpp.

Member Function Documentation

◆ activeConnection()

NetworkManager::ActiveConnection::Ptr Device::activeConnection ( ) const

The current active connection for this device.

Returns
A valid ActiveConnection object or NULL if no active connection was found

Definition at line 421 of file device.cpp.

◆ activeConnectionChanged

void NetworkManager::Device::activeConnectionChanged ( )
signal

Emitted when the autoconnect of this network has changed.

◆ as() [1/2]

template<class DevIface >
DevIface * NetworkManager::Device::as ( )
inline

Retrieves a specialized interface to interact with the device corresponding to a given device interface.

Returns
a pointer to the device interface if it exists, 0 otherwise

Definition at line 453 of file device.h.

◆ as() [2/2]

template<class DevIface >
const DevIface * NetworkManager::Device::as ( ) const
inline

Retrieves a specialized interface to interact with the device corresponding to a given device interface.

Returns
a pointer to the device interface if it exists, 0 otherwise

Definition at line 465 of file device.h.

◆ autoconnect()

bool Device::autoconnect ( ) const

If the device is allowed to autoconnect.

Definition at line 448 of file device.cpp.

◆ autoconnectChanged

void NetworkManager::Device::autoconnectChanged ( )
signal

Emitted when the autoconnect of this network has changed.

◆ availableConnectionAppeared

void NetworkManager::Device::availableConnectionAppeared ( const QString & connection)
signal

Emitted when a new connection is available.

◆ availableConnectionChanged

void NetworkManager::Device::availableConnectionChanged ( )
signal

Emitted when the list of avaiable connections of this network has changed.

◆ availableConnectionDisappeared

void NetworkManager::Device::availableConnectionDisappeared ( const QString & connection)
signal

Emitted when the connection is no longer available.

◆ availableConnections()

NetworkManager::Connection::List Device::availableConnections ( )

Returns available connections for this device.

Returns
List of availables connection

Definition at line 427 of file device.cpp.

◆ capabilities()

NetworkManager::Device::Capabilities Device::capabilities ( ) const

Retrieves the capabilities supported by this device.

Returns
the capabilities of the device

Definition at line 601 of file device.cpp.

◆ capabilitiesChanged

void NetworkManager::Device::capabilitiesChanged ( )
signal

Emitted when the capabilities of this network has changed.

◆ capabilitiesV()

QVariant Device::capabilitiesV ( ) const

Definition at line 607 of file device.cpp.

◆ connectionStateChanged

void NetworkManager::Device::connectionStateChanged ( )
signal

Emitted when the connection state of this network has changed.

◆ deleteInterface()

QDBusPendingReply Device::deleteInterface ( )

Deletes a software device from NetworkManager and removes the interface from the system.

The method returns an error when called for a hardware device.

Since
5.8.0

Definition at line 579 of file device.cpp.

◆ designSpeed()

int Device::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 595 of file device.cpp.

◆ deviceStatistics()

NetworkManager::DeviceStatistics::Ptr Device::deviceStatistics ( ) const

Returns Device Statistics interface.

Definition at line 613 of file device.cpp.

◆ dhcp4Config()

NetworkManager::Dhcp4Config::Ptr Device::dhcp4Config ( ) const

Get the DHCP options returned by the DHCP server or a null pointer if the device is not Activated or does not use DHCP configuration.

Definition at line 502 of file device.cpp.

◆ dhcp4ConfigChanged

void NetworkManager::Device::dhcp4ConfigChanged ( )
signal

Emitted when the DHCP configuration for IPv4 of this network has changed.

◆ dhcp6Config()

NetworkManager::Dhcp6Config::Ptr Device::dhcp6Config ( ) const

Get the DHCP options returned by the DHCP server or a null pointer if the device is not Activated or does not use DHCP configuration.

Definition at line 511 of file device.cpp.

◆ dhcp6ConfigChanged

void NetworkManager::Device::dhcp6ConfigChanged ( )
signal

Emitted when the DHCP configuration for IPv6 of this network has changed.

◆ disconnectInterface()

QDBusPendingReply Device::disconnectInterface ( )

Disconnects a device and prevents the device from automatically activating further connections without user intervention.

Definition at line 573 of file device.cpp.

◆ driver()

QString Device::driver ( ) const

Handle for the system driver controlling this network interface.

Definition at line 403 of file device.cpp.

◆ driverChanged

void NetworkManager::Device::driverChanged ( )
signal

Emitted when the driver of this network has changed.

◆ driverVersion()

QString Device::driverVersion ( ) const

The driver version.

Definition at line 409 of file device.cpp.

◆ driverVersionChanged

void NetworkManager::Device::driverVersionChanged ( )
signal

Emitted when the driver version of this network has changed.

◆ firmwareMissing()

bool Device::firmwareMissing ( ) const

Is the firmware needed by the device missing?

Definition at line 442 of file device.cpp.

◆ firmwareMissingChanged

void NetworkManager::Device::firmwareMissingChanged ( )
signal

Emitted when the firmware missing state of this network has changed.

◆ firmwareVersion()

QString Device::firmwareVersion ( ) const

The firmware version.

Definition at line 415 of file device.cpp.

◆ firmwareVersionChanged

void NetworkManager::Device::firmwareVersionChanged ( )
signal

Emitted when the firmware version of this network has changed.

◆ interfaceFlags()

NetworkManager::Device::Interfaceflags Device::interfaceFlags ( ) const

The up or down flag for the device.

Definition at line 543 of file device.cpp.

◆ interfaceFlagsChanged

void NetworkManager::Device::interfaceFlagsChanged ( )
signal

Emitted when the up or down state of the device.

Since
1.22
Note
will always return NM_DEVICE_INTERFACE_FLAG_NONE when runtime NM < 1.22

◆ interfaceName()

QString Device::interfaceName ( ) const

The system name for the network device.

Definition at line 391 of file device.cpp.

◆ interfaceNameChanged

void NetworkManager::Device::interfaceNameChanged ( )
signal

Emitted when the interface name of this network has changed.

◆ ipInterfaceChanged

void NetworkManager::Device::ipInterfaceChanged ( )
signal

Emitted when the ip interface name of this network has changed.

◆ ipInterfaceName()

QString Device::ipInterfaceName ( ) const

The name of the device's data interface when available.

This property may not refer to the actual data interface until the device has successfully established a data connection, indicated by the device's state() becoming ACTIVATED.

Definition at line 397 of file device.cpp.

◆ ipV4Address()

QHostAddress Device::ipV4Address ( ) const

returns the current IPv4 address without the prefix

See also
ipV4Config()
ipV6Config()
Deprecated

Definition at line 472 of file device.cpp.

◆ ipV4AddressChanged

void NetworkManager::Device::ipV4AddressChanged ( )
signal

Emitted when the IPv4 address of this network has changed.

◆ ipV4Config()

NetworkManager::IpConfig Device::ipV4Config ( ) const

Get the current IPv4 configuration of this device.

Only valid when device is Activated.

Definition at line 484 of file device.cpp.

◆ ipV4ConfigChanged

void NetworkManager::Device::ipV4ConfigChanged ( )
signal

Emitted when the IPv4 configuration of this network has changed.

◆ ipV6Config()

NetworkManager::IpConfig Device::ipV6Config ( ) const

Get the current IPv6 configuration of this device.

Only valid when device is Activated.

Definition at line 493 of file device.cpp.

◆ ipV6ConfigChanged

void NetworkManager::Device::ipV6ConfigChanged ( )
signal

Emitted when the IPv6 configuration of this network has changed.

◆ isActive()

bool Device::isActive ( ) const

Retrieves the activation status of this network interface.

Returns
true if this network interface is active, false otherwise

Definition at line 520 of file device.cpp.

◆ isValid()

bool Device::isValid ( ) const

Retrieves the device is valid.

Returns
true if this device interface is valid, false otherwise

Definition at line 531 of file device.cpp.

◆ managed()

bool Device::managed ( ) const

Is the device currently being managed by NetworkManager?

Definition at line 537 of file device.cpp.

◆ managedChanged

void NetworkManager::Device::managedChanged ( )
signal

Emitted when the managed state of this network has changed.

◆ metered()

NetworkManager::Device::MeteredStatus Device::metered ( ) const
Returns
Whether the amount of traffic flowing through the device is subject to limitations, for example set by service providers.
Since
5.14.0

Definition at line 561 of file device.cpp.

◆ meteredChanged

void NetworkManager::Device::meteredChanged ( MeteredStatus metered)
signal

Emitted when metered property has changed.

Since
5.14.0
See also
metered

◆ mtu()

uint Device::mtu ( ) const

The device MTU (maximum transmission unit)

Since
0.9.9.0

Definition at line 549 of file device.cpp.

◆ mtuChanged

void NetworkManager::Device::mtuChanged ( )
signal

Emitted when the maximum transmission unit has changed.

Since
0.9.9.0

◆ nmPluginMissing()

bool Device::nmPluginMissing ( ) const
Returns
If TRUE, indicates the NetworkManager plugin for the device is likely missing or misconfigured.
Since
5.14.0

Definition at line 555 of file device.cpp.

◆ nmPluginMissingChanged

void NetworkManager::Device::nmPluginMissingChanged ( bool nmPluginMissing)
signal

Emitted when NmPluginMissing property has changed.

Since
5.14.0
See also
nmPluginMissing

◆ physicalPortId()

QString Device::physicalPortId ( ) const
Returns
If non-empty, an (opaque) indicator of the physical network port associated with the device. This can be used to recognize when two seemingly-separate hardware devices are actually just different virtual interfaces to the same physical port.
Since
0.9.9.0

Definition at line 466 of file device.cpp.

◆ physicalPortIdChanged

void NetworkManager::Device::physicalPortIdChanged ( )
signal

Emitted when the physical port ID changes.

See also
physicalPortId()
Since
0.9.9.0

◆ reapplyConnection()

QDBusPendingReply Device::reapplyConnection ( const NMVariantMapMap & connection,
qulonglong version_id,
uint flags )

Reapplies connection settings on the interface.

Definition at line 567 of file device.cpp.

◆ setAutoconnect()

void Device::setAutoconnect ( bool autoconnect)

If true, indicates the device is allowed to autoconnect.

If false, manual intervention is required before the device will automatically connect to a known network, such as activating a connection using the device, or setting this property to true.

Definition at line 454 of file device.cpp.

◆ state()

NetworkManager::Device::State Device::state ( ) const

Retrieves the current state of the device.

This is a high level view of the device. It is user oriented, so actually it provides state coming from different layers.

Returns
the current connection state
See also
Device::State

Definition at line 589 of file device.cpp.

◆ stateChanged

void NetworkManager::Device::stateChanged ( NetworkManager::Device::State newstate,
NetworkManager::Device::State oldstate,
NetworkManager::Device::StateChangeReason reason )
signal

This signal is emitted when the device's link status changed.

Parameters
newstatethe new state of the connection
oldstatethe previous state of the connection
reasonthe reason for the state change, if any. ReasonNone where the backend provides no reason.
See also
Device::State
Device::StateChangeReason

◆ stateReason()

NetworkManager::DeviceStateReason Device::stateReason ( ) const

The current state and reason for changing to that state.

Definition at line 478 of file device.cpp.

◆ stateReasonChanged

void NetworkManager::Device::stateReasonChanged ( )
signal

Emitted when the state reason of this network has changed.

◆ type()

◆ udi()

QString Device::udi ( ) const

Retrieves the Unique Device Identifier (UDI) of the device.

This identifier is unique for each device in the system.

Definition at line 460 of file device.cpp.

◆ udiChanged

void NetworkManager::Device::udiChanged ( )
signal

Emitted when the Unique Device Identifier of this device has changed.

◆ uni()

QString Device::uni ( ) const

Retrieves the Unique Network Identifier (UNI) of the device.

This identifier is unique for each network and network interface in the system.

Returns
the Unique Network Identifier of the current device

Definition at line 385 of file device.cpp.

Member Data Documentation

◆ d_ptr

DevicePrivate* const NetworkManager::Device::d_ptr
protected

Definition at line 625 of file device.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:00:27 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.