Класс QNetworkConfiguration

Класс QNetworkConfiguration предоставляет абстракцию одной или нескольких конфигураций точек доступа. Подробнее...

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

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

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

Функции публичного доступа

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

QNetworkConfiguration инкапсулирует одну точку доступа или сеть обслуживания. В большинстве случаев единственная конфигурация точки доступа может быть сопоставлена одному сетевому интерфейсу. Однако один сетевой интерфейс не всегда может сопоставляться только с одной конфигурацией точки доступа. Несколько конфигураций для одного сетевого устройства могут включать несколько точек доступа. Примером устройства, которое может иметь такую конфигурацию, является смартфон, который позволяет пользователю управлять несколькими конфигурациями WLAN, в то время как само устройство имеет только одно сетевое устройство WLAN.

QNetworkConfiguration также поддерживает понятие сетевых сервисов. Это понятие позволяет сгруппировать несколько конфигураций точек доступа в один объект. Такая группа называется сетью обслуживания и может быть полезна в случаях, когда требуется сетевая сессия с определенной целевой сетью (например, корпоративная сеть). При использовании сети обслуживания пользователь обычно не заботится о том, какой из вариантов подключения выбран (например, корпоративная сеть WLAN или VPN через GPRS), пока он может получить доступ к целевому серверу компании. В зависимости от текущего местоположения и времени некоторые из точек доступа, составляющих сеть обслуживания, могут быть недоступны. Кроме того, можно включить автоматический переход к точкам доступа, что позволяет устройству динамически изменять конфигурацию сетевого интерфейса, сохраняя при этом подключение приложений к целевой сети. Это позволяет адаптироваться к изменяющейся среде и может оптимизировать затраты, скорость или другие сетевые параметры.

Специальные конфигурации типа UserChoice предоставляют конфигурацию-заполнитель, которая разрешается платформой в фактическую конфигурацию сети при открытии сессии. Не все платформы поддерживают концепцию конфигурации пользовательского выбора.

Состояния конфигурации

Список доступных конфигураций можно получить с помощью QNetworkConfigurationManager::allConfigurations(). Конфигурация может иметь несколько состояний. Состояние конфигурации Defined указывает, что конфигурация сохранена на устройстве. Однако конфигурация еще не готова к активации, так как, например, WLAN может быть недоступен в данный момент.

Состояние Discovered подразумевает, что конфигурация Defined и внешние условия таковы, что конфигурацию можно немедленно использовать для открытия новой сетевой сессии. Примером такого внешнего условия может быть подключение Ethernet-кабеля к устройству или доступность WLAN с указанным идентификатором сети.

Состояние Active подразумевает, что конфигурация Discovered. Конфигурация в этом состоянии в настоящее время используется приложением. У базового сетевого интерфейса есть действительная IP-конфигурация, и он может передавать IP-пакеты между устройством и целевой сетью.

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

В зависимости от типа конфигурации некоторые состояния являются временными. Подключение GPRS/UMTS почти всегда может быть Discovered, если сеть GSM/UMTS доступна. Однако если сеть GSM/UMTS теряет подключение, связанная конфигурация может изменить свое состояние с Discovered на Defined. Аналогичный случай может быть вызван доступностью WLAN. QNetworkConfigurationManager::updateConfigurations() можно использовать для ручного запуска обновлений состояний. Обратите внимание, что на некоторых платформах такие обновления не требуются, так как они неявно изменяют состояние после обнаружения. Если состояние конфигурации изменяется, все связанные экземпляры QNetworkConfiguration автоматически изменяют свое состояние.

См. также QNetworkSession и QNetworkConfigurationManager.

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

перечисление QNetworkConfiguration::BearerType

Указывает тип носителя, используемого конфигурацией.

enum QNetworkConfiguration::Purpose

Определяет назначение конфигурации.

enum QNetworkConfiguration::StateFlagflags QNetworkConfiguration::StateFlags

Определяет состояния конфигурации.

Тип StateFlags является псевдонимом для QFlags<StateFlag>. Он хранит логическое ИЛИ комбинацию значений StateFlag.

enum QNetworkConfiguration::Type

Этот перечисление описывает тип конфигурации.

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

QNetworkConfiguration::QNetworkConfiguration(const QNetworkConfiguration &other)

Создаёт копию объекта QNetworkConfiguration, содержащегося в other.

QNetworkConfiguration::QNetworkConfiguration()

Конструирует объект недействительной конфигурации.

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

QNetworkConfiguration &QNetworkConfiguration::operator=(const QNetworkConfiguration &other)

Копирует содержимое объекта QNetworkConfiguration, содержащегося в other, в текущий объект.

QNetworkConfiguration::~QNetworkConfiguration()

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

QNetworkConfiguration::BearerType QNetworkConfiguration::bearerType() const

Возвращает тип носителя, используемого этой сетевой конфигурацией.

Если тип носителя неизвестен, функция bearerTypeName() может использоваться для получения текстового имени типа носителя.

Недействительная сетевая конфигурация всегда возвращает значение BearerUnknown.

См. также bearerTypeName() и bearerTypeFamily().

QNetworkConfiguration::BearerType QNetworkConfiguration::bearerTypeFamily() const

Возвращает семейство типов носителя, используемых этой сетевой конфигурацией. Следующая таблица показывает, как значения bearerType() отображаются в значения bearerTypeFamily():

Недействительная конфигурация сети всегда возвращает значение BearerUnknown.

Эта функция была добавлена в Qt 5.2.

См. также bearerType() и bearerTypeName().

QString QNetworkConfiguration::bearerTypeName() const

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

Строка не переводится и поэтому не может быть показана пользователю. В следующей таблице показаны фиксированные сопоставления между BearerType и именем типа носителя для известных типов. Если BearerType неизвестен, эта функция может вернуть дополнительную информацию, если она доступна; в противном случае будет возвращена пустая строка.

Эта функция возвращает пустую строку, если это недействительная конфигурация, конфигурация сети типа QNetworkConfiguration::ServiceNetwork или QNetworkConfiguration::UserChoice.

См. также bearerType() и bearerTypeFamily().

QList<QNetworkConfiguration> QNetworkConfiguration::children() const

Возвращает все дочерние конфигурации этой конфигурации сети в порядке приоритета. Первая дочерняя конфигурация в списке имеет наивысший приоритет.

Только конфигурации сетей типа ServiceNetwork могут иметь дочерние элементы. В противном случае эта функция возвращает пустой список.

int QNetworkConfiguration::connectTimeout() const

Возвращает таймаут подключения для этой конфигурации.

Эта функция была добавлена в Qt 5.9.

См. также setConnectTimeout.

QString QNetworkConfiguration::identifier() const

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

bool QNetworkConfiguration::isRoamingAvailable() const

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

bool QNetworkConfiguration::isValid() const

Возвращает true , если этот объект QNetworkConfiguration действителен. Конфигурация может стать недействительной, если пользователь удалит конфигурацию или конфигурация была создана по умолчанию.

Добавление и удаление конфигураций можно отслеживать с помощью QNetworkConfigurationManager.

См. также QNetworkConfigurationManager.

QString QNetworkConfiguration::name() const

Возвращает отображаемое пользователем имя этой конфигурации.

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

QNetworkConfiguration::Purpose QNetworkConfiguration::purpose() const

Возвращает назначение этой конфигурации.

Поле назначения может использоваться для программированного определения назначения конфигурации. Такая информация обычно является частью метаданных точки доступа или сети обслуживания.

bool QNetworkConfiguration::setConnectTimeout(int timeout)

Устанавливает таймаут подключения для этой конфигурации в timeout. Это позволяет управлять таймаутом, используемым QAbstractSocket для установления подключения.

Примечание: timeout задаётся в миллисекундах.

Предупреждение: Это не повлияет, если плагин носителя не имеет возможности CanStartAndStopInterfaces.

Возвращает true, если операция выполнена успешно.

Эта функция была добавлена в Qt 5.9.

См. также connectTimeout.

QNetworkConfiguration::StateFlags QNetworkConfiguration::state() const

Возвращает текущее состояние конфигурации.

void QNetworkConfiguration::swap(QNetworkConfiguration &other)

Меняет местами эту конфигурацию сети с other. Эта функция очень быстрая и никогда не терпит неудачу.

Эта функция была добавлена в Qt 5.0.

QNetworkConfiguration::Type QNetworkConfiguration::type() const

Возвращает тип конфигурации.

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

bool QNetworkConfiguration::operator!=(const QNetworkConfiguration &other) const

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

bool QNetworkConfiguration::operator==(const QNetworkConfiguration &other) const

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