Класс QHostInfo
Класс QHostInfo предоставляет статические функции для поиска по имени хоста. Подробнее...
| Заголовок: | #include <QHostInfo> |
| CMake: | find_package(Qt6 COMPONENTS Network REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Network) |
| qmake: | QT += network |
Примечание: Все функции в этом классе являются реентерабельными.
Типы публичного доступа
| Перечисление | HostInfoError { NoError, HostNotFound, UnknownError } |
Функции публичного доступа
| QHostInfo(QHostInfo &&other) | |
| QHostInfo(const QHostInfo &other) | |
| QHostInfo(int id = -1) | |
| QHostInfo & | operator=(QHostInfo &&other) |
| QHostInfo & | operator=(const QHostInfo &other) |
| ~QHostInfo() | |
| QList<QHostAddress> | addresses() const |
| QHostInfo::HostInfoError | error() const |
| QString | errorString() const |
| QString | hostName() const |
| int | lookupId() const |
| void | setAddresses(const QList<QHostAddress> &addresses) |
| void | setError(QHostInfo::HostInfoError error) |
| void | setErrorString(const QString &str) |
| void | setHostName(const QString &hostName) |
| void | setLookupId(int id) |
| void | swap(QHostInfo &other) |
Статические публичные члены
| void | abortHostLookup(int id) |
| QHostInfo | fromName(const QString &name) |
| QString | localDomainName() |
| QString | localHostName() |
| int | lookupHost(const QString &name, QObject *receiver, const char *member) |
| int | lookupHost(const QString &name, Functor functor) |
| int | lookupHost(const QString &name, const QObject *context, Functor functor) |
Подробное описание
QHostInfo находит IP-адрес(ы), связанный(ые) с именем хоста, или имя хоста, связанное(ые) с IP-адресом. Класс предоставляет две статические функции-удобства: одна работает асинхронно и выдает сигнал, как только хост будет найден, и одна, которая блокируется и возвращает объект QHostInfo.
Для асинхронного поиска IP-адресов хоста вызовите lookupHost(), которая принимает имя или IP-адрес хоста, объект-получатель и подпись слота в качестве аргументов и возвращает идентификатор. Вы можете прервать поиск, вызвав abortHostLookup() с идентификатором поиска.
Пример:
// To find the IP address of qt-project.org
QHostInfo::lookupHost("qt-project.org",
this, SLOT(printResults(QHostInfo)));
// To find the host name for 4.2.2.1
QHostInfo::lookupHost("4.2.2.1",
this, SLOT(printResults(QHostInfo))); Слот вызывается, когда результаты готовы. Результаты хранятся в объекте QHostInfo. Вызовите addresses(), чтобы получить список IP-адресов хоста, и hostName(), чтобы получить имя хоста, который был найден.
Если поиск не удался, error() возвращает тип произошедшей ошибки. errorString() предоставляет удобочитаемое описание ошибки поиска.
Если вам нужен блокирующий поиск, используйте функцию QHostInfo::fromName():
QHostInfo info = QHostInfo::fromName("qt-project.org"); QHostInfo поддерживает имена международных доменных имен (IDN) через стандарты IDNA и Punycode.
Для получения имени локального хоста используйте статическую функцию QHostInfo::localHostName().
QHostInfo использует механизмы, предоставляемые операционной системой для выполнения поиска. Согласно {https://tools.ietf.org/html/rfc6724}{RFC 6724} нет гарантии, что все IP-адреса, зарегистрированные для домена или хоста, будут возвращены.
Примечание: начиная с Qt 4.6.1 QHostInfo использует несколько потоков для поиска DNS вместо одного выделенного потока DNS. Это улучшает производительность, но также изменяет порядок выдачи сигналов при использовании lookupHost() по сравнению с предыдущими версиями Qt.
Примечание: начиная с Qt 4.6.3 QHostInfo использует небольшой внутренний кеш DNS на 60 секунд для повышения производительности.
См. также QAbstractSocket, RFC 3492 и RFC 6724.
Документация по типу члена
Перечисление QHostInfo::HostInfoError
Это перечисление описывает различные ошибки, которые могут возникнуть при попытке разрешения имени хоста.
| Константа | Значение | Описание |
|---|---|---|
QHostInfo::NoError |
0 |
Поиск выполнен успешно. |
QHostInfo::HostNotFound |
1 |
IP-адреса для хоста не были найдены. |
QHostInfo::UnknownError |
2 |
Произошла неизвестная ошибка. |
См. также error() и setError().
Документация по документации функций члена
[since 5.14] QHostInfo::QHostInfo(QHostInfo &&other)
Создает новый QHostInfo из other с использованием перемещения.
Примечание: Перемещаемый объект other помещается в частично сформированное состояние, в котором единственными допустимыми операциями являются уничтожение и присвоение нового значения.
Эта функция была добавлена в Qt 5.14.
QHostInfo::QHostInfo(const QHostInfo &other)
Создает копию other.
QHostInfo::QHostInfo(int id = -1)
Создает пустой объект host info с идентификатором поиска id.
См. также lookupId().
[since 5.10] QHostInfo &QHostInfo::operator=(QHostInfo &&other)
Присваивает other этому экземпляру QHostInfo с помощью перемещения.
Примечание: Перемещаемый объект other помещается в частично сформированное состояние, в котором единственными допустимыми операциями являются уничтожение и присвоение нового значения.
Эта функция была добавлена в Qt 5.10.
QHostInfo &QHostInfo::operator=(const QHostInfo &other)
Присваивает данные объекта other объекту host info и возвращает ссылку на него.
QHostInfo::~QHostInfo()
Уничтожает объект host info.
[static] void QHostInfo::abortHostLookup(int id)
Прерывает поиск хоста с идентификатором id, как возвращается функцией lookupHost().
См. также lookupHost() и lookupId().
QList<QHostAddress> QHostInfo::addresses() const
Возвращает список IP-адресов, связанных с hostName(). Этот список может быть пустым.
Пример:
QHostInfo info;
...
if (!info.addresses().isEmpty()) {
QHostAddress address = info.addresses().first();
// use the first IP address
} См. также setAddresses(), hostName() и error().
QHostInfo::HostInfoError QHostInfo::error() const
Возвращает тип ошибки, произошедшей при поиске имени хоста; в противном случае возвращает NoError.
См. также setError() и errorString().
QString QHostInfo::errorString() const
Если поиск завершился ошибкой, эта функция возвращает удобочитаемое описание ошибки; в противном случае возвращается «Неизвестная ошибка».
См. также setErrorString() и error().
[static] QHostInfo QHostInfo::fromName(const QString &name)
Ищет IP-адрес(ы) для заданного имени хоста name. Функция блокируется во время поиска, что означает приостановку выполнения программы до готовности результатов поиска. Возвращает результат поиска в объекте QHostInfo.
Если вы передаете литерный IP-адрес в name вместо имени хоста, QHostInfo будет искать доменное имя для IP (т.е., QHostInfo выполнит обратный поиск). При успехе возвращаемый QHostInfo будет содержать как разрешенное доменное имя, так и IP-адреса для имени хоста.
См. также lookupHost().
QString QHostInfo::hostName() const
Возвращает имя хоста, чьи IP-адреса были найдены.
См. также setHostName() и localHostName().
[static] QString QHostInfo::localDomainName()
Возвращает DNS-домен этой машины.
Примечание: DNS-домены не связаны с доменными именами, используемыми в сетях Windows.
См. также hostName().
[static] QString QHostInfo::localHostName()
Возвращает имя хоста этой машины, если оно настроено. Обратите внимание, что имена хостов не гарантируют глобальную уникальность, особенно если они были настроены автоматически.
Эта функция не гарантирует, что возвращаемое имя хоста является полным доменным именем (FQDN). Для этого используйте fromName() для разрешения возвращаемого имени в FQDN.
Эта функция возвращает то же, что и QSysInfo::machineHostName().
См. также hostName() и localDomainName().
[static] int QHostInfo::lookupHost(const QString &name, QObject *receiver, const char *member)
Ищет IP-адрес(ы), связанные с именем хоста name, и возвращает идентификатор поиска. Когда результат поиска готов, вызывается слот или сигнал member в receiver с аргументом QHostInfo. Объект QHostInfo затем можно просмотреть, чтобы получить результаты поиска.
Поиск выполняется одним вызовом функции, например:
QHostInfo::lookupHost("www.kde.org",
this, SLOT(lookedUp(QHostInfo))); Реализация слота выводит основную информацию об адресах, возвращенных поиском, или сообщает об ошибке, если поиск не удался:
void MyWidget::lookedUp(const QHostInfo &host)
{
if (host.error() != QHostInfo::NoError) {
qDebug() << "Lookup failed:" << host.errorString();
return;
}
const auto addresses = host.addresses();
for (const QHostAddress &address : addresses)
qDebug() << "Found address:" << address.toString();
} Если вы передаете литерный IP-адрес в name вместо имени хоста, QHostInfo будет искать доменное имя для IP (т.е., QHostInfo выполнит обратный поиск). При успехе результирующий QHostInfo будет содержать как разрешенное доменное имя, так и IP-адреса для имени хоста. Пример:
QHostInfo::lookupHost("4.2.2.1",
this, SLOT(lookedUp(QHostInfo))); Примечание: Нет гарантии порядка вывода сигналов, если вы запускаете несколько запросов с помощью lookupHost().
См. также abortHostLookup(), addresses(), error() и fromName().
[static, since 5.9] template <typename Functor> int QHostInfo::lookupHost(const QString &name, Functor functor)
Это перегруженная функция.
Ищет IP-адрес(ы), связанные с именем хоста name, и возвращает идентификатор поиска. Когда результат поиска готов, вызывается functor с аргументом QHostInfo. Объект QHostInfo затем можно просмотреть, чтобы получить результаты поиска.
Functor будет выполняться в потоке, который выполняет вызов lookupHost; этот поток должен иметь работающий цикл событий Qt.
Примечание: Нет гарантии порядка вывода сигналов, если вы запускаете несколько запросов с помощью lookupHost().
Эта функция была добавлена в Qt 5.9.
См. также abortHostLookup(), addresses(), error() и fromName().
[static, since 5.9] template <typename Functor> int QHostInfo::lookupHost(const QString &name, const QObject *context, Functor functor)
Это перегруженная функция.
Ищет IP-адрес(ы), связанные с именем хоста name, и возвращает идентификатор поиска. Когда результат поиска готов, вызывается functor с аргументом QHostInfo. Объект QHostInfo затем можно просмотреть, чтобы получить результаты поиска.
Если context уничтожен до завершения поиска, functor не будет вызван. Functor будет выполняться в потоке context. Поток контекста должен иметь работающий цикл событий Qt.
Вот альтернативная сигнатура функции:
lookupHost(const QString &name, const QObject *receiver, PointerToMemberFunction function)
В этом случае, когда результат поиска готов, слот или сигнал function в receiver вызывается с аргументом QHostInfo. Объект QHostInfo затем можно просмотреть, чтобы получить результаты поиска.
Примечание: Нет гарантии порядка вывода сигналов, если вы запускаете несколько запросов с помощью lookupHost().
Эта функция была добавлена в Qt 5.9.
См. также abortHostLookup(), addresses(), error() и fromName().
int QHostInfo::lookupId() const
Возвращает идентификатор этого поиска.
См. также setLookupId(), abortHostLookup() и hostName().
void QHostInfo::setAddresses(const QList<QHostAddress> &addresses)
Устанавливает список адресов в этом QHostInfo на addresses.
См. также addresses().
void QHostInfo::setError(QHostInfo::HostInfoError error)
Устанавливает тип ошибки этого QHostInfo на error.
См. также error() и errorString().
void QHostInfo::setErrorString(const QString &str)
Устанавливает удобочитаемое описание произошедшей ошибки на str, если поиск завершился ошибкой.
См. также errorString() и setError().
void QHostInfo::setHostName(const QString &hostName)
Устанавливает имя хоста этого QHostInfo на hostName.
См. также hostName().
void QHostInfo::setLookupId(int id)
Устанавливает ID этого поиска на id.
См. также lookupId() и lookupHost().
[since 5.10] void QHostInfo::swap(QHostInfo &other)
Меняет местами информацию о хосте other с этой информацией о хосте. Эта операция очень быстрая и никогда не терпит неудачу.
Эта функция была добавлена в Qt 5.10.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.0/qhostinfo.html