Класс QNetworkInterface

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

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

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

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

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

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

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

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

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

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

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

См. также QNetworkAddressEntry.

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

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

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

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

Тип InterfaceFlags является типом-синонимом для QFlags<InterfaceFlag>. Он хранит результат побитового ИЛИ сочетания значений InterfaceFlag.

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

Указывает тип аппаратного обеспечения (PHY-уровень, уровень OSI 1) этого интерфейса, если он может быть определен. Типы интерфейсов, которые не входят в список ниже, обычно будут указаны как 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 не хранят конфигурацию для удобочитаемых имён.

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

int QNetworkInterface::index() const

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

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

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

[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] 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 в противном случае.

Максимальный размер пакета (MTU) — это максимальный размер пакета, который может быть отправлен по этому интерфейсу без фрагментации на уровне канала. Приложения могут использовать это значение для расчета размера полезной нагрузки, которая поместится в нефрагментированный 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().