QNetworkConfigurationManager Class

Member Function Documentation

QNetworkConfigurationManager::QNetworkConfigurationManager(QObject *parent = nullptr)

Constructs a QNetworkConfigurationManager with the given parent.

Note that to ensure a valid list of current configurations immediately available, updating is done during construction which causes some delay.

[signal] void QNetworkConfigurationManager::configurationAdded(const QNetworkConfiguration &config)

This signal is emitted whenever a new network configuration is added to the system. The new configuration is specified by config.

[signal] void QNetworkConfigurationManager::configurationChanged(const QNetworkConfiguration &config)

This signal is emitted when the state of config changes.

[signal] void QNetworkConfigurationManager::configurationRemoved(const QNetworkConfiguration &config)

This signal is emitted when a configuration is about to be removed from the system. The removed configuration, specified by config, is invalid but retains name and identifier.

[signal] void QNetworkConfigurationManager::onlineStateChanged(bool isOnline)

This signal is emitted when the device changes from online to offline mode or vice versa. isOnline represents the new state of the device.

The state is considered to be online for as long as allConfigurations(QNetworkConfiguration::Active) returns a list with at least one entry.

[signal] void QNetworkConfigurationManager::updateCompleted()

This signal is emitted when the configuration update has been completed. Such an update can be initiated via updateConfigurations().

[slot] void QNetworkConfigurationManager::updateConfigurations()

Initiates an update of all configurations. This may be used to initiate WLAN scans or other time consuming updates which may be required to obtain the correct state for configurations.

This call is asynchronous. On completion of this update the updateCompleted() signal is emitted. If new configurations are discovered or old ones were removed or changed the update process may trigger the emission of one or multiple configurationAdded(), configurationRemoved() and configurationChanged() signals.

If a configuration state changes as a result of this update all existing QNetworkConfiguration instances are updated automatically.

See also allConfigurations().

[virtual] QNetworkConfigurationManager::~QNetworkConfigurationManager()

Frees the resources associated with the QNetworkConfigurationManager object.

QList<QNetworkConfiguration> QNetworkConfigurationManager::allConfigurations(QNetworkConfiguration::StateFlags filter = QNetworkConfiguration::StateFlags()) const

Returns the list of configurations which comply with the given filter.

By default this function returns all (defined and undefined) configurations.

A wireless network with a particular SSID may only be accessible in a certain area despite the fact that the system has a valid configuration for it. Therefore the filter flag may be used to limit the list to discovered and possibly connected configurations only.

If filter is set to zero this function returns all possible configurations.

Note that this function returns the states for all configurations as they are known at the time of this function call. If for instance a configuration of type WLAN is defined the system may have to perform a WLAN scan in order to determine whether it is actually available. To obtain the most accurate state updateConfigurations() should be used to update each configuration's state. Note that such an update may require some time. It's completion is signalled by updateCompleted(). In the absence of a configuration update this function returns the best estimate at the time of the call. Therefore, if WLAN configurations are of interest, it is recommended that updateConfigurations() is called once after QNetworkConfigurationManager instantiation (WLAN scans are too time consuming to perform in constructor). After this the data is kept automatically up-to-date as the system reports any changes.

QNetworkConfigurationManager::Capabilities QNetworkConfigurationManager::capabilities() const

Returns the capabilities supported by the current platform.

QNetworkConfiguration QNetworkConfigurationManager::configurationFromIdentifier(const QString &identifier) const

Returns the QNetworkConfiguration for identifier; otherwise returns an invalid QNetworkConfiguration.

See also QNetworkConfiguration::identifier().

QNetworkConfiguration QNetworkConfigurationManager::defaultConfiguration() const

Returns the default configuration to be used. This function always returns a discovered configuration; otherwise an invalid configuration.

In some cases it may be required to call updateConfigurations() and wait for the updateCompleted() signal before calling this function.

See also allConfigurations().

bool QNetworkConfigurationManager::isOnline() const

Returns true if the system is considered to be connected to another device via an active network interface; otherwise returns false.

This is equivalent to the following code snippet:

 QNetworkConfigurationManager mgr;
 QList<QNetworkConfiguration> activeConfigs = mgr.allConfigurations(QNetworkConfiguration::Active);
 if (activeConfigs.count() > 0)
     Q_ASSERT(mgr.isOnline());
 else
     Q_ASSERT(!mgr.isOnline());

See also onlineStateChanged().