Класс QNetworkInterface

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

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

Примечание: Все функции в этом классе являются перевходящими.

Типы публичного интерфейса

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

Статические публичные члены

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

Класс 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

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

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

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

QNetworkInterface::QNetworkInterface()

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

QNetworkInterface::QNetworkInterface(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 не хранят конфигурацию для удобочитаемых имён.

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

int QNetworkInterface::index() const

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

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

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

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

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

Этот индекс также содержится в поле ID области IPv6-адреса.

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

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

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

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

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

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

QNetworkInterface::interfaceFromName(name).index()

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

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

[static] QString QNetworkInterface::interfaceNameFromIndex(int index)

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

QNetworkInterface::interfaceFromIndex(index).name()

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

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

bool QNetworkInterface::isValid() const

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

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 это внутренний идентификатор, который пользователь изменить не может.

void QNetworkInterface::swap(QNetworkInterface &other)

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

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

QNetworkInterface::InterfaceType QNetworkInterface::type() const

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

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

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

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

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

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

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