Класс QNetworkConfiguration

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

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

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

Открытые функции

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

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

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

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

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

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

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

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

Состояние 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 является typedef для QFlags<StateFlag>. Он хранит логическое ИЛИ комбинацию значений StateFlag.

enum QNetworkConfiguration::Type

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

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

QNetworkConfiguration::QNetworkConfiguration()

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

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

QNetworkConfiguration::QNetworkConfiguration(const QNetworkConfiguration &other)

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

QNetworkConfiguration::~QNetworkConfiguration()

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

BearerType QNetworkConfiguration::bearerType() const

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

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

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

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

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

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

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

Purpose QNetworkConfiguration::purpose() const

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

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

bool QNetworkConfiguration::setConnectTimeout(int timeout)

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

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

Возвращает true, если удалось.

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

См. также connectTimeout.

StateFlags QNetworkConfiguration::state() const

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

void QNetworkConfiguration::swap(QNetworkConfiguration &other)

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

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

Type QNetworkConfiguration::type() const

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

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

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

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

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

Оператор присваивания перемещения.

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

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

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

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