Класс QNetworkInterface

Класс QNetworkInterface предоставляет список IP-адресов и сетевых интерфейсов хоста. Подробнее...

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

Примечание: Все функции в этом классе являются реентерабельными.

Типы

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

Статические открытые члены

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

QNetworkInterface представляет один сетевой интерфейс, подключенный к хосту, на котором выполняется программа. Каждый сетевой интерфейс может содержать ноль или более IP-адресов, каждый из которых необязательно связан с маской сети и/или широковещательным адресом. Список таких троек можно получить с помощью addressEntries(). В качестве альтернативы, когда маска сети, широковещательные адреса или другая информация не нужны, используйте удобную функцию allAddresses(), чтобы получить только IP-адреса активных интерфейсов.

QNetworkInterface также сообщает аппаратный адрес интерфейса с помощью hardwareAddress().

Не все операционные системы поддерживают отчет обо всех функциях. Только IPv4-адреса гарантированно перечислены в этом классе на всех платформах. В частности, перечисление IPv6-адресов поддерживается только в Windows, Linux, macOS и BSD.

См. также QNetworkAddressEntry.

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

перечисление QNetworkInterface::InterfaceFlagфлаги QNetworkInterface::InterfaceFlags

Указывает флаги, связанные с этим сетевым интерфейсом. Возможные значения:

Обратите внимание, что один сетевой интерфейс не может быть одновременно и широковещательным, и точкой-точкой.

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

перечисление QNetworkInterface::InterfaceType

Указывает тип оборудования (PHY-уровень, уровень 1 модели OSI) этого интерфейса, если это можно определить. Типы интерфейсов, которые не входят в список ниже, обычно будут перечислены как Неизвестно, хотя в будущих версиях Qt могут быть добавлены новые значения перечисления.

Возможные значения:

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

QNetworkInterface::QNetworkInterface(const QNetworkInterface &other)

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

QNetworkInterface::QNetworkInterface()

Конструирует пустой объект сетевого интерфейса.

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

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

QNetworkInterface::~QNetworkInterface()

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

QList<QNetworkAddressEntry> QNetworkInterface::addressEntries() const

Возвращает список IP-адресов, которые имеет этот интерфейс, вместе с соответствующими масками подсетей и адресами широковещательной рассылки.

Если маска подсети, адрес широковещательной рассылки или другая информация не нужны, можно вызвать функцию allAddresses(), чтобы получить только IP-адреса активных интерфейсов.

[static] QList<QHostAddress> QNetworkInterface::allAddresses()

Эта функция-помощник возвращает все IP-адреса, найденные на компьютере. Она эквивалентна вызову addressEntries() для всех объектов, возвращаемых функцией allInterfaces(), которые находятся в состоянии QNetworkInterface::IsUp, чтобы получить списки объектов QNetworkAddressEntry, а затем вызову QNetworkAddressEntry::ip() для каждого из них.

[static] QList<QNetworkInterface> QNetworkInterface::allInterfaces()

Возвращает список всех сетевых интерфейсов, найденных на компьютере. В случае ошибки возвращает список с нулевым количеством элементов.

QNetworkInterface::InterfaceFlags QNetworkInterface::flags() const

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

QString QNetworkInterface::hardwareAddress() const

Возвращает низкоуровневый аппаратный адрес этого интерфейса. Для интерфейсов Ethernet это будет MAC-адрес в строковом представлении, разделённый двоеточиями.

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

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

QString QNetworkInterface::humanReadableName() const

Возвращает удобочитаемое имя этого сетевого интерфейса в Windows, например, "Подключение к локальной сети", если имя может быть определено. Если нет, то функция возвращает то же, что и name(). Удобочитаемое имя — это имя, которое пользователь может изменить в Панели управления Windows, поэтому оно может измениться во время выполнения программы.

В Unix эта функция в настоящее время всегда возвращает то же самое, что и name(), так как системы Unix не хранят конфигурацию для удобочитаемых имён.

int QNetworkInterface::index() const

Возвращает системный индекс интерфейса, если он известен. Это целое число, назначенное операционной системой для идентификации этого интерфейса, и оно, как правило, не меняется. Оно соответствует полю идентификатора области в IPv6-адресах.

Если индекс неизвестен, эта функция возвращает 0.

[static] QNetworkInterface QNetworkInterface::interfaceFromIndex(int index)

Возвращает объект QNetworkInterface для интерфейса, внутренний идентификатор которого равен index. Сетевые интерфейсы имеют уникальный идентификатор, называемый "индексом интерфейса", для отличия от других интерфейсов в системе. Часто это значение назначается последовательно, а удалённые и вновь добавленные интерфейсы каждый раз получают другое значение.

Этот индекс также можно найти в поле идентификатора области IPv6-адреса.

[static] QNetworkInterface QNetworkInterface::interfaceFromName(const QString &name)

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

Строка name может быть либо фактическим именем интерфейса (таким как "eth0" или "en1"), либо индексом интерфейса в строковом формате ("1", "2" и т. д.).

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

[static, since 5.7] int QNetworkInterface::interfaceIndexFromName(const QString &name)

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

    QNetworkInterface::interfaceFromName(name).index()

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

См. также interfaceFromName(), interfaceNameFromIndex() и QNetworkDatagram::interfaceIndex().

[static, since 5.7] QString QNetworkInterface::interfaceNameFromIndex(int index)

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

    QNetworkInterface::interfaceFromIndex(index).name()

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

См. также interfaceFromIndex(), interfaceIndexFromName(), и QNetworkDatagram::interfaceIndex().

bool QNetworkInterface::isValid() const

Возвращает true, если этот объект QNetworkInterface содержит действительные сведения о сетевом интерфейсе.

[since 5.11] int QNetworkInterface::maximumTransmissionUnit() const

Возвращает максимальный размер пакета (MTU) для этого интерфейса, если известен, иначе 0.

Максимальный размер пакета — это наибольший пакет, который может быть отправлен по этому интерфейсу без фрагментации на уровне канала связи. Приложения могут использовать это значение для расчета размера полезной нагрузки, которая поместится в неповреждённый UDP-датаграмму. Не забудьте вычесть размеры заголовков, используемых в вашем общении по интерфейсу, например, TCP (20 байт) или UDP (12), IPv4 (20) или IPv6 (40, без некоторых форм сжатия заголовков), при расчёте размера передаваемой полезной нагрузки. Обратите также внимание, что MTU по всему пути (Path MTU) до пункта назначения может быть меньше MTU интерфейса.

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

См. также QUdpSocket.

QString QNetworkInterface::name() const

Возвращает имя этого сетевого интерфейса. В системах Unix это строка, содержащая тип интерфейса и, необязательно, порядковый номер, например, "eth0", "lo" или "pcn0". В Windows это внутренний идентификатор, который не может быть изменён пользователем.

[since 5.0] void QNetworkInterface::swap(QNetworkInterface &other)

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

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

[since 5.11] QNetworkInterface::InterfaceType QNetworkInterface::type() const

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

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

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