Класс QNetworkProxyQuery

Класс QNetworkProxyQuery используется для запроса настроек прокси для сокета. Подробнее...

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

Открытые типы

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

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

Класс QNetworkProxyQuery используется для запроса настроек прокси для сокета.

QNetworkProxyQuery содержит детали создаваемого сокета или выполняемого запроса. Он используется классами QNetworkProxy и QNetworkProxyFactory для предоставления приложениям более точного управления тем, какие прокси-серверы используются в зависимости от деталей запроса. Это позволяет приложению применять различные настройки в зависимости от протокола или имени хоста назначения, например.

QNetworkProxyQuery поддерживает следующие критерии для выбора прокси:

• тип запроса
• номер локального порта для использования
• имя хоста назначения
• номер порта назначения
• имя протокола, например, "http" или "ftp"
• запрашиваемый URL

Имя хоста назначения — это хост в соединении в случае исходящих сокетов. Это параметр hostName, передаваемый в QTcpSocket::connectToHost() или компонент хоста запрошенного URL с помощью QNetworkRequest.

Номер порта назначения — запрашиваемый порт для подключения в случае исходящих сокетов, а номер локального порта — порт, который сокет хочет использовать локально перед попыткой внешнего подключения. В большинстве случаев номер локального порта используется только сокетами прослушивания (QTcpSocket) или сокетами дейтаграмм (QUdpSocket).

Имя протокола — произвольная строка, которая указывает тип ищуемого соединения. Например, она может соответствовать схеме URL, например, "http", "https" и "ftp". В большинстве случаев выбор прокси не изменяется в зависимости от протокола, но эта информация предоставляется на случай, если можно сделать лучший выбор, например, выбрать прокси-сервер кэширования HTTP для соединений на основе HTTP, но более мощный прокси SOCKSv5 для всех остальных.

Настройка сети определяет, какую конфигурацию использовать, когда используется управление носителем. Например, на мобильном телефоне настройки прокси, вероятно, будут отличаться для сотовой сети по сравнению с Wi-Fi.

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

Следует отметить, что некоторые критерии могут отсутствовать или быть неизвестными (пустая QString для имени хоста или имени протокола, -1 для номеров портов). В этом случае функции, выполняющие запрос, должны сделать предположение или применить некоторые значения по умолчанию, определенные реализацией.

См. также QNetworkProxy, QNetworkProxyFactory, QNetworkAccessManager и QAbstractSocket::setProxy().

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

enum QNetworkProxyQuery::QueryType

Описывает тип запроса QNetworkProxyQuery.

См. также queryType() и setQueryType().

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

QNetworkProxyQuery::QNetworkProxyQuery()

Создаёт объект QNetworkProxyQuery по умолчанию. По умолчанию тип запроса будет QNetworkProxyQuery::TcpSocket.

QNetworkProxyQuery::QNetworkProxyQuery(const QUrl &requestUrl, QNetworkProxyQuery::QueryType queryType = UrlRequest)

Создаёт QNetworkProxyQuery с URL requestUrl и задаёт тип запроса queryType.

См. также protocolTag(), peerHostName() и peerPort().

QNetworkProxyQuery::QNetworkProxyQuery(const QString &hostname, int port, const QString &protocolTag = QString(), QNetworkProxyQuery::QueryType queryType = TcpSocket)

Создаёт QNetworkProxyQuery типа queryType и задаёт тег протокола protocolTag. Этот конструктор подходит для запросов QNetworkProxyQuery::TcpSocket, так как он устанавливает имя хоста удалённого узла в hostname и номер порта удалённого узла в port.

QNetworkProxyQuery::QNetworkProxyQuery(quint16 bindPort, const QString &protocolTag = QString(), QNetworkProxyQuery::QueryType queryType = TcpServer)

Создаёт QNetworkProxyQuery типа queryType и задаёт тег протокола protocolTag. Этот конструктор подходит для запросов QNetworkProxyQuery::TcpSocket, поскольку он устанавливает номер локального порта в bindPort.

Обратите внимание, что bindPort имеет тип quint16, чтобы указать точный запрашиваемый номер порта. Значение -1 (неизвестно) в данном контексте недопустимо.

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

QNetworkProxyQuery::QNetworkProxyQuery(const QNetworkProxyQuery &other)

Создаёт объект QNetworkProxyQuery, который является копией other.

QNetworkProxyQuery::~QNetworkProxyQuery()

Удаляет этот объект QNetworkProxyQuery.

int QNetworkProxyQuery::localPort() const

Возвращает номер порта сокета, который будет принимать входящие пакеты от удалённых серверов, или -1, если порт неизвестен.

См. также peerPort(), peerHostName() и setLocalPort().

QString QNetworkProxyQuery::peerHostName() const

Возвращает имя хоста или IP-адрес запрашиваемого исходящего подключения, или пустую строку, если имя удалённого хоста неизвестно.

Если тип запроса QNetworkProxyQuery::UrlRequest, эта функция возвращает компонент хоста запрашиваемого URL.

См. также peerPort(), localPort() и setPeerHostName().

int QNetworkProxyQuery::peerPort() const

Возвращает номер порта для исходящего запроса или -1, если номер порта неизвестен.

Если тип запроса QNetworkProxyQuery::UrlRequest, эта функция возвращает номер порта запрашиваемого URL. В общем случае фреймворки заполнят номер порта из своих значений по умолчанию.

См. также peerHostName(), localPort() и setPeerPort().

QString QNetworkProxyQuery::protocolTag() const

Возвращает тег протокола для этого объекта QNetworkProxyQuery или пустую QString, если тег протокола неизвестен.

В случае запросов типа QNetworkProxyQuery::UrlRequest эта функция возвращает значение компонента схемы URL.

См. также setProtocolTag() и url().

QNetworkProxyQuery::QueryType QNetworkProxyQuery::queryType() const

Возвращает тип запроса.

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

void QNetworkProxyQuery::setLocalPort(int port)

Устанавливает номер порта сокета, который хочет использовать локально для принятия входящих пакетов от удалённых серверов, в port. Локальный порт чаще всего используется с типами запросов QNetworkProxyQuery::TcpServer и QNetworkProxyQuery::UdpSocket.

Допустимые значения: от 0 до 65535 (при этом 0 означает, что любой номер порта будет приемлем) или -1, что означает, что локальный номер порта неизвестен или не применим.

В некоторых случаях, для специальных протоколов, локальный номер порта также может использоваться с запросом типа QNetworkProxyQuery::TcpSocket. В этом случае сокет указывает, что хочет использовать номер порта port при подключении к удалённому хосту.

См. также localPort(), setPeerPort() и setPeerHostName().

void QNetworkProxyQuery::setPeerHostName(const QString &hostname)

Устанавливает имя хоста исходящего соединения в hostname. Пустое имя хоста может использоваться для указания того, что удалённый хост неизвестен.

Имя удалённого хоста также может использоваться для указания ожидаемого исходного адреса входящего подключения в случае типов запросов QNetworkProxyQuery::UdpSocket или QNetworkProxyQuery::TcpServer.

См. также peerHostName(), setPeerPort() и setLocalPort().

void QNetworkProxyQuery::setPeerPort(int port)

Устанавливает запрашиваемый номер порта исходящего соединения в port. Допустимые значения: от 1 до 65535 или -1 для указания того, что номер удалённого порта неизвестен.

Номер порта удалённого узла также может использоваться для указания ожидаемого номера порта входящего подключения в случае типов запросов QNetworkProxyQuery::UdpSocket или QNetworkProxyQuery::TcpServer.

См. также peerPort(), setPeerHostName() и setLocalPort().

void QNetworkProxyQuery::setProtocolTag(const QString &protocolTag)

Устанавливает тег протокола для этого объекта QNetworkProxyQuery в protocolTag.

Тег протокола — это произвольная строка, которая указывает, какой протокол используется по сокету, например, «http», «xmpp», «telnet» и т. д. Тег протокола используется бэкендом для возврата запроса, более специфичного для конкретного протокола: например, для HTTP-соединения может использоваться кеширующий HTTP-прокси-сервер, в то время как для всех остальных соединений используется более мощный прокси-сервер SOCKSv5.

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

void QNetworkProxyQuery::setQueryType(QNetworkProxyQuery::QueryType type)

Устанавливает тип запроса этого объекта на type.

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

void QNetworkProxyQuery::setUrl(const QUrl &url)

Устанавливает компонент URL этого объекта QNetworkProxyQuery на url. Установка URL также установит тег протокола, имя удалённого хоста и номер порта. Это делается для упрощения реализации кода, определяющего используемый прокси-сервер.

См. также url(), peerHostName() и peerPort().

void QNetworkProxyQuery::swap(QNetworkProxyQuery &other)

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

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

QUrl QNetworkProxyQuery::url() const

Возвращает компонент URL этого объекта QNetworkProxyQuery в случае запроса типа QNetworkProxyQuery::UrlRequest.

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

bool QNetworkProxyQuery::operator!=(const QNetworkProxyQuery &other) const

Возвращает true, если этот объект QNetworkProxyQuery не содержит тех же данных, что и other.

QNetworkProxyQuery &QNetworkProxyQuery::operator=(QNetworkProxyQuery &&other)

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

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

Копирует содержимое other.

bool QNetworkProxyQuery::operator==(const QNetworkProxyQuery &other) const

Возвращает true, если этот объект QNetworkProxyQuery содержит те же данные, что и other.