Класс 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, объединённых оператором OR.

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

Определяет тип аппаратного обеспечения (физический уровень, уровень 1 модели OSI), если он может быть определен. Интерфейсы, типы которых не указаны ниже, как правило, будут перечислены как Unknown, хотя в будущих версиях 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

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

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

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

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

Этот индекс также встречается в поле scope ID адреса 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 по всему пути (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().