Contents

• Public Types
• Public Functions
• Public Slots
• Signals
• Detailed Description

Detailed Description

TheQNetworkConfigurationManager class manages the network configurations provided by the system.

QNetworkConfigurationManager provides access to the network configurations known to the system and enables applications to detect the system capabilities (with regards to network sessions) at runtime.

AQNetworkConfiguration abstracts a set of configuration options describing how a network interface has to be configured to connect to a particular target network.QNetworkConfigurationManager maintains and updates the global list of QNetworkConfigurations. Applications can access and filter this list viaallConfigurations(). If a new configuration is added or an existing one is removed or changed theconfigurationAdded(),configurationRemoved() andconfigurationChanged() signals are emitted respectively.

ThedefaultConfiguration() can be used when intending to immediately create a new network session without caring about the particular configuration. It returns aQNetworkConfiguration::Discovered configuration. If there are not any discovered ones an invalid configuration is returned.

Some configuration updates may require some time to perform updates. A WLAN scan is such an example. Unless the platform performs internal updates it may be required to manually trigger configuration updates viaQNetworkConfigurationManager::updateConfigurations(). The completion of the update process is indicated by emitting theupdateCompleted() signal. The update process ensures that every existingQNetworkConfiguration instance is updated. There is no need to ask for a renewed configuration list viaallConfigurations().

Member Type Documentation

enum QNetworkConfigurationManager::Capability
flags QNetworkConfigurationManager::Capabilities

Specifies the system capabilities of the bearer API. The possible values are:

The Capabilities type is a typedef forQFlags<Capability>. It stores an OR combination of Capability values.

Member Function Documentation

QNetworkConfigurationManager::QNetworkConfigurationManager(QObject * parent = 0)

Constructs aQNetworkConfigurationManager with the givenparent.

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

[virtual]QNetworkConfigurationManager::~QNetworkConfigurationManager()

Frees the resources associated with theQNetworkConfigurationManager object.

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

Returns the list of configurations which comply with the givenfilter.

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.

Iffilter 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 stateupdateConfigurations() should be used to update each configuration's state. Note that such an update may require some time. It's completion is signalled byupdateCompleted(). 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 thatupdateConfigurations() is called once afterQNetworkConfigurationManager 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.

[signal]void QNetworkConfigurationManager::configurationAdded(constQNetworkConfiguration & config)

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

[signal]void QNetworkConfigurationManager::configurationChanged(constQNetworkConfiguration & config)

This signal is emitted when thestate ofconfig changes.

QNetworkConfiguration QNetworkConfigurationManager::configurationFromIdentifier(constQString & identifier) const

Returns theQNetworkConfiguration foridentifier; otherwise returns an invalidQNetworkConfiguration.

See alsoQNetworkConfiguration::identifier().

[signal]void QNetworkConfigurationManager::configurationRemoved(constQNetworkConfiguration & config)

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

This function was introduced in Qt 4.8.

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 callupdateConfigurations() and wait for theupdateCompleted() signal before calling this function.

See alsoallConfigurations().

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())elseQ_ASSERT(!mgr.isOnline())

See alsoonlineStateChanged().

[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 asallConfigurations(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 viaupdateConfigurations().

[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 theupdateCompleted() 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 multipleconfigurationAdded(),configurationRemoved() andconfigurationChanged() signals.

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

See alsoallConfigurations().