Класс QNetworkConfigurationManager

Класс QNetworkConfigurationManager управляет сетевыми конфигурациями, предоставляемыми системой. Подробнее...

Этот класс был представлен в Qt 4.7.

• Список всех членов, включая унаследованные

Типы публичного доступа

Публичные функции

Открытые слоты

Сигналы

Подробное описание

QNetworkConfigurationManager предоставляет доступ к сетевым конфигурациям, известным системе, и позволяет приложениям обнаруживать возможности системы (в отношении сетевых сессий) во время выполнения.

QNetworkConfiguration абстрагирует набор параметров конфигурации, описывающих, как сетевой интерфейс должен быть настроен для подключения к определенной целевой сети. QNetworkConfigurationManager сохраняет и обновляет глобальный список QNetworkConfigurations. Приложения могут получить доступ и отфильтровать этот список с помощью allConfigurations(). Если добавляется новая конфигурация или существующая удаляется или изменяется, соответственно, генерируются сигналы configurationAdded(), configurationRemoved() и configurationChanged().

Метод defaultConfiguration() можно использовать, когда требуется немедленно создать новую сетевую сессию, не заботясь о конкретной конфигурации. Он возвращает конфигурацию QNetworkConfiguration::Discovered. Если таковых нет, возвращается недействительная конфигурация.

Некоторые обновления конфигурации могут потребовать некоторого времени для выполнения. Пример — сканирование беспроводной сети. Если платформа не выполняет внутренних обновлений, может потребоваться вручную инициировать обновления конфигурации с помощью QNetworkConfigurationManager::updateConfigurations(). Завершение процесса обновления обозначается генерацией сигнала updateCompleted(). Процесс обновления гарантирует, что каждый существующий экземпляр QNetworkConfiguration обновлен. Нет необходимости запрашивать обновлённый список конфигураций с помощью allConfigurations().

См. также QNetworkConfiguration.

Документация по типам членов

enum QNetworkConfigurationManager::Capabilityflags QNetworkConfigurationManager::Capabilities

Указывает возможности системы API носителя. Возможные значения:

Тип Capabilities — это typedef для QFlags<Capability>. Он хранит логическое ИЛИ сочетание значений Capability.

Документация по функциям-членам

QNetworkConfigurationManager::QNetworkConfigurationManager(QObject *parent = nullptr)

Конструирует QNetworkConfigurationManager с заданным parent.

Обратите внимание, что для обеспечения немедленного доступа к правильному списку текущих конфигураций обновление выполняется во время конструирования, что приводит к некоторой задержке.

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

Этот сигнал генерируется всякий раз, когда к системе добавляется новая сетевая конфигурация. Новая конфигурация определяется параметром config.

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

Этот сигнал излучается, когда состояние config изменяется.

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

Этот сигнал излучается, когда конфигурация должна быть удалена из системы. Удаленная конфигурация, указанная config, недействительна, но сохраняет имя и идентификатор.

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

Этот сигнал излучается, когда устройство переключается из режима онлайн в офлайн или наоборот. isOnline представляет новое состояние устройства.

Состояние считается онлайн, пока allConfigurations(QNetworkConfiguration::Active) возвращает список с хотя бы одной записью.

[signal] void QNetworkConfigurationManager::updateCompleted()

Этот сигнал излучается, когда обновление конфигурации завершено. Такое обновление может быть инициировано с помощью updateConfigurations().

[slot] void QNetworkConfigurationManager::updateConfigurations()

Инициирует обновление всех конфигураций. Это может использоваться для запуска сканирования WLAN или других длительных обновлений, которые могут потребоваться для получения правильного состояния конфигураций.

Этот вызов асинхронный. По завершении этого обновления излучается сигнал updateCompleted(). Если обнаружены новые конфигурации или старые были удалены или изменены, процесс обновления может вызвать излучение одного или нескольких сигналов configurationAdded(), configurationRemoved() и configurationChanged().

Если состояние конфигурации изменяется в результате этого обновления, все существующие экземпляры QNetworkConfiguration обновляются автоматически.

См. также allConfigurations().

[virtual] QNetworkConfigurationManager::~QNetworkConfigurationManager()

Освобождает ресурсы, связанные с объектом QNetworkConfigurationManager.

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

Возвращает список конфигураций, которые соответствуют заданному filter.

По умолчанию эта функция возвращает все (определенные и неопределенные) конфигурации.

Беспроводная сеть с определенным SSID может быть доступна только в определенной области, несмотря на то, что система имеет для неё действительную конфигурацию. Поэтому флаг фильтра может использоваться для ограничения списка только открытыми и, возможно, подключенными конфигурациями.

Если filter равен нулю, эта функция возвращает все возможные конфигурации.

Обратите внимание, что эта функция возвращает состояния всех конфигураций, как они известны на момент вызова этой функции. Например, если определена конфигурация типа WLAN, система может выполнить сканирование WLAN, чтобы определить, действительно ли она доступна. Для получения наиболее точного состояния следует использовать updateConfigurations() для обновления состояния каждой конфигурации. Обратите внимание, что такое обновление может занять некоторое время. О его завершении сигнализируется с помощью updateCompleted(). При отсутствии обновления конфигурации эта функция возвращает лучшее приближение на момент вызова. Следовательно, если конфигурации WLAN представляют интерес, рекомендуется вызвать updateConfigurations() один раз после создания экземпляра QNetworkConfigurationManager (сканирование WLAN занимает слишком много времени, чтобы выполнять его в конструкторе). После этого данные автоматически сохраняются актуальными, поскольку система сообщает о любых изменениях.

QNetworkConfigurationManager::Capabilities QNetworkConfigurationManager::capabilities() const

Возвращает поддерживаемые текущей платформой возможности.

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

Возвращает QNetworkConfiguration для identifier; в противном случае возвращает недействительную QNetworkConfiguration.

См. также QNetworkConfiguration::identifier().

QNetworkConfiguration QNetworkConfigurationManager::defaultConfiguration() const

Возвращает используемую по умолчанию конфигурацию. Эта функция всегда возвращает обнаруженную конфигурацию; в противном случае недействительную конфигурацию.

В некоторых случаях может потребоваться вызвать updateConfigurations() и дождаться сигнала updateCompleted() перед вызовом этой функции.

См. также allConfigurations().

bool QNetworkConfigurationManager::isOnline() const

Возвращает true , если система считается подключенной к другому устройству через активный сетевой интерфейс; в противном случае возвращает false.

Это эквивалентно следующему фрагменту кода:

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

См. также onlineStateChanged().