NetworkManager::Device Class

Member Function Documentation

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

Creates a new device object.

path UNI of the device

[override virtual noexcept] Device::~Device()

Destroys a device object.

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

[signal] void Device::activeConnectionChanged()

Emitted when the autoconnect of this network has changed.

template <typename DevIface> DevIface *Device::as()

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

template <typename DevIface> const DevIface *Device::as() const

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

bool Device::autoconnect() const

If the device is allowed to autoconnect.

See also setAutoconnect().

[signal] void Device::autoconnectChanged()

Emitted when the autoconnect of this network has changed.

[signal] void Device::availableConnectionAppeared(const QString &connection)

Emitted when a new connection is available

[signal] void Device::availableConnectionChanged()

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

[signal] void Device::availableConnectionDisappeared(const QString &connection)

Emitted when the connection is no longer available

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

Returns available connections for this device

Returns List of availables connection

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

Retrieves the capabilities supported by this device.

Returns the capabilities of the device

[signal] void Device::capabilitiesChanged()

Emitted when the capabilities of this network has changed.

QVariant Device::capabilitiesV() const

[signal] void Device::connectionStateChanged()

Emitted when the connection state of this network has changed.

[since 5.8.0] 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.

This function was introduced in 5.8.0.

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

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

Returns Device Statistics interface

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.

[signal] void Device::dhcp4ConfigChanged()

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

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.

[signal] void Device::dhcp6ConfigChanged()

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

QDBusPendingReply<> Device::disconnectInterface()

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

QString Device::driver() const

Handle for the system driver controlling this network interface

[signal] void Device::driverChanged()

Emitted when the driver of this network has changed.

QString Device::driverVersion() const

The driver version.

[signal] void Device::driverVersionChanged()

Emitted when the driver version of this network has changed.

bool Device::firmwareMissing() const

Is the firmware needed by the device missing?

[signal] void Device::firmwareMissingChanged()

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

QString Device::firmwareVersion() const

The firmware version.

[signal] void Device::firmwareVersionChanged()

Emitted when the firmware version of this network has changed.

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

The up or down flag for the device

[signal, since 1.22] void Device::interfaceFlagsChanged()

Emitted when the up or down state of the device

This function was introduced in 1.22.

QString Device::interfaceName() const

The system name for the network device

[signal] void Device::interfaceNameChanged()

Emitted when the interface name of this network has changed.

[signal] void Device::ipInterfaceChanged()

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

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.

[signal] void Device::ipV4AddressChanged()

Emitted when the IPv4 address of this network has changed.

NetworkManager::IpConfig Device::ipV4Config() const

Get the current IPv4 configuration of this device. Only valid when device is Activated.

[signal] void Device::ipV4ConfigChanged()

Emitted when the IPv4 configuration of this network has changed.

NetworkManager::IpConfig Device::ipV6Config() const

Get the current IPv6 configuration of this device. Only valid when device is Activated.

[signal] void Device::ipV6ConfigChanged()

Emitted when the IPv6 configuration of this network has changed.

bool Device::isActive() const

Retrieves the activation status of this network interface.

Returns true if this network interface is active, false otherwise

bool Device::isValid() const

Retrieves the device is valid.

Returns true if this device interface is valid, false otherwise

bool Device::managed() const

Is the device currently being managed by NetworkManager?

[signal] void Device::managedChanged()

Emitted when the managed state of this network has changed.

[since 5.14.0] 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.

This function was introduced in 5.14.0.

[signal, since 5.14.0] void Device::meteredChanged(NetworkManager::Device::MeteredStatus metered)

Emitted when metered property has changed

This function was introduced in 5.14.0.

See also metered.

[since 0.9.9.0] uint Device::mtu() const

The device MTU (maximum transmission unit)

This function was introduced in 0.9.9.0.

[signal, since 0.9.9.0] void Device::mtuChanged()

Emitted when the maximum transmission unit has changed

This function was introduced in 0.9.9.0.

[since 5.14.0] bool Device::nmPluginMissing() const

Returns If TRUE, indicates the NetworkManager plugin for the device is likely missing or misconfigured.

This function was introduced in 5.14.0.

[signal, since 5.14.0] void Device::nmPluginMissingChanged(bool nmPluginMissing)

Emitted when NmPluginMissing property has changed

This function was introduced in 5.14.0.

See also nmPluginMissing.

[since 0.9.9.0] 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.

This function was introduced in 0.9.9.0.

[signal, since 0.9.9.0] void Device::physicalPortIdChanged()

Emitted when the physical port ID changes.

This function was introduced in 0.9.9.0.

See also physicalPortId().

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

Reapplies connection settings on the interface.

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.

See also autoconnect().

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.

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

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

newstate the new state of the connection

oldstate the previous state of the connection

reason the reason for the state change, if any. ReasonNone where the backend provides no reason.

See also Device::State and Device::StateChangeReason.

NetworkManager::DeviceStateReason Device::stateReason() const

The current state and reason for changing to that state.

[signal] void Device::stateReasonChanged()

Emitted when the state reason of this network has changed.

[virtual] NetworkManager::Device::Type Device::type() const

Retrieves the interface type. This is a virtual function that will return the proper type of all sub-classes.

Returns the NetworkManager::Device::Type that corresponds to this device.

QString Device::udi() const

Retrieves the Unique Device Identifier (UDI) of the device. This identifier is unique for each device in the system.

[signal] void Device::udiChanged()

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

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