Класс QNetworkProxy

Класс QNetworkProxy предоставляет прокси-сервер для сетевого уровня. Подробнее...

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

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

Публичные типы

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

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

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

QNetworkProxy предоставляет метод для настройки поддержки прокси-сервера на уровне сети для классов Qt сети. В настоящее время поддерживаются классы QAbstractSocket, QTcpSocket, QUdpSocket, QTcpServer и QNetworkAccessManager. Поддержка прокси-сервера разработана для максимальной прозрачности. Это означает, что существующие сетевые приложения, которые вы написали, должны автоматически поддерживать сетевой прокси с помощью следующего кода.

QNetworkProxy proxy;
proxy.setType(QNetworkProxy::Socks5Proxy);
proxy.setHostName("proxy.example.com");
proxy.setPort(1080);
proxy.setUser("username");
proxy.setPassword("password");
QNetworkProxy::setApplicationProxy(proxy);

Альтернативой настройке прокси для всего приложения является указание прокси для отдельных сокетов с помощью QAbstractSocket::setProxy() и QTcpServer::setProxy(). Таким образом, можно отключить использование прокси для определенных сокетов с помощью следующего кода:

serverSocket->setProxy(QNetworkProxy::NoProxy);

Сетевой прокси не используется, если адрес, используемый в connectToHost(), bind() или listen(), эквивалентен QHostAddress::LocalHost или QHostAddress::LocalHostIPv6.

Каждый тип поддержки прокси имеет определенные ограничения. Вы должны внимательно прочитать документацию по ProxyType перед выбором типа прокси для использования.

SOCKS5

Поддержка SOCKS5 с Qt 4 основана на RFC 1928 и RFC 1929. Поддерживаемые методы аутентификации — отсутствие аутентификации и аутентификация по имени пользователя/паролю. Поддерживаются как IPv4, так и IPv6. Имена доменов разрешаются через сервер SOCKS5, если включена опция QNetworkProxy::HostNameLookupCapability, в противном случае они разрешаются локально, и IP-адрес отправляется на сервер. Следует помнить о нескольких моментах при использовании SOCKS5 с QUdpSocket и QTcpServer:

В случае с QUdpSocket, вызов bind() может завершиться ошибкой с истечением времени ожидания. Если в bind() указан номер порта, отличный от 0, нет гарантии, что будет использован именно этот порт. Используйте localPort() и localAddress(), чтобы получить фактический используемый адрес и номер порта. Поскольку проксированный UDP проходит через два UDP-соединения, есть большая вероятность потери пакетов.

В случае с QTcpServer, вызов listen() может завершиться ошибкой с истечением времени ожидания. Если в listen() указан номер порта, отличный от 0, нет гарантии, что будет использован именно этот порт. Используйте serverPort() и serverAddress(), чтобы получить фактический адрес и порт, используемые для прослушивания соединений. SOCKS5 поддерживает только одно принятое соединение на вызов listen(), и каждый вызов, вероятно, приведет к использованию другого serverPort().

См. также QAbstractSocket и QTcpServer.

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

enum QNetworkProxy::Capabilityflags QNetworkProxy::Capabilities

Эти флаги указывают на возможности, которые поддерживает данный прокси-сервер.

QNetworkProxy устанавливает различные возможности по умолчанию при создании объекта (см. QNetworkProxy::ProxyType для списка значений по умолчанию). Однако, после создания объекта можно изменить возможности с помощью setCapabilities().

Поддерживаемые QNetworkProxy возможности:

Тип Capabilities — это typedef для QFlags<Capability>. Он хранит результат логического ИЛИ для значений Capability.

enum QNetworkProxy::ProxyType

Этот перечисление описывает типы сетевого проксирования, предоставляемые в Qt.

Qt понимает два типа прокси: прозрачные прокси и прокси с кэшированием. Первая группа состоит из прокси, которые могут обрабатывать любые произвольные передачи данных, а вторая — только определённые запросы. Кэширующие прокси имеют смысл только для тех классов, где они могут использоваться.

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

Также обратите внимание, что не следует устанавливать прокси по умолчанию для приложения (setApplicationProxy()) на прокси, не имеющий возможности TunnelingCapability. В противном случае QTcpSocket не сможет открывать соединения.

См. также setType(), type(), capabilities(), и setCapabilities().

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

QNetworkProxy::QNetworkProxy(const QNetworkProxy &other)

Создаёт копию other.

QNetworkProxy::QNetworkProxy(QNetworkProxy::ProxyType type, const QString &hostName = QString(), quint16 port = 0, const QString &user = QString(), const QString &password = QString())

Создаёт QNetworkProxy с type, hostName, port, user и password.

Значения по умолчанию для возможностей прокси типа type устанавливаются автоматически.

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

QNetworkProxy::QNetworkProxy()

Создаёт QNetworkProxy с типом DefaultProxy.

Тип прокси определяется параметром applicationProxy(), который по умолчанию равен NoProxy или системному прокси, если он настроен.

См. также setType() и setApplicationProxy().

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

Присваивает значение сетевого прокси other этому сетевому прокси.

QNetworkProxy::~QNetworkProxy()

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

[static] QNetworkProxy QNetworkProxy::applicationProxy()

Возвращает проксирование сети на уровне приложения.

Если у QAbstractSocket или QTcpSocket тип QNetworkProxy::DefaultProxy, то QNetworkProxy, возвращаемый этой функцией, используется.

См. также QNetworkProxyFactory, setApplicationProxy(), QAbstractSocket::proxy(), и QTcpServer::proxy().

QNetworkProxy::Capabilities QNetworkProxy::capabilities() const

Возвращает возможности этого прокси-сервера.

См. также setCapabilities() и type().

[since 5.0] bool QNetworkProxy::hasRawHeader(const QByteArray &headerName) const

Возвращает true если сырой заголовок headerName используется для этого прокси. Возвращает false если прокси не является типа HttpProxy или HttpCachingProxy.

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

См. также rawHeader() и setRawHeader().

[since 5.0] QVariant QNetworkProxy::header(QNetworkRequest::KnownHeaders header) const

Возвращает значение известного сетевого заголовка header, если он используется для этого прокси. Если его нет, возвращает QVariant() (т.е. недействительную переменную).

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

См. также QNetworkRequest::KnownHeaders, rawHeader() и setHeader().

QString QNetworkProxy::hostName() const

Возвращает имя хоста прокси-сервера.

См. также setHostName(), setPort() и port().

bool QNetworkProxy::isCachingProxy() const

Возвращает true, если этот прокси поддерживает возможность кэширования QNetworkProxy::CachingCapability.

В Qt 4.4 возможность кэширования была связана с типом прокси, но начиная с Qt 4.5 можно отключить возможность кэширования для прокси, вызвав setCapabilities().

См. также capabilities(), type() и isTransparentProxy().

bool QNetworkProxy::isTransparentProxy() const

Возвращает true, если этот прокси поддерживает прозрачное туннелирование TCP-соединений. Это соответствует возможности QNetworkProxy::TunnelingCapability.

В Qt 4.4 возможность была связана с типом прокси, но начиная с Qt 4.5 можно отключить возможность кэширования для прокси, вызвав setCapabilities().

См. также capabilities(), type() и isCachingProxy().

QString QNetworkProxy::password() const

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

См. также user(), setPassword() и setUser().

quint16 QNetworkProxy::port() const

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

См. также setHostName(), setPort() и hostName().

[since 5.0] QByteArray QNetworkProxy::rawHeader(const QByteArray &headerName) const

Возвращает исходную форму заголовка headerName. Если такого заголовка нет или прокси не является типа HttpProxy или HttpCachingProxy, возвращается пустой QByteArray, что может быть неотличимо от заголовка, который присутствует, но не имеет содержимого (используйте hasRawHeader(), чтобы узнать, существует ли заголовок).

Необработанные заголовки можно задать с помощью setRawHeader() или setHeader().

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

См. также header() и setRawHeader().

[since 5.0] QList<QByteArray> QNetworkProxy::rawHeaderList() const

Возвращает список всех необработанных заголовков, заданных в этом сетевом прокси. Список находится в порядке, в котором заголовки были заданы.

Если прокси не является типа HttpProxy или HttpCachingProxy, возвращается пустой QList.

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

См. также hasRawHeader() и rawHeader().

[static] void QNetworkProxy::setApplicationProxy(const QNetworkProxy &networkProxy)

Устанавливает проксирование на уровне приложения на networkProxy.

Если у QAbstractSocket или QTcpSocket тип QNetworkProxy::DefaultProxy, то используется QNetworkProxy, установленный с помощью этой функции. Если вам нужна большая гибкость в определении используемого прокси, используйте класс QNetworkProxyFactory.

Установка значения прокси по умолчанию с помощью этой функции переопределит заводской прокси приложения, установленный с помощью QNetworkProxyFactory::setApplicationProxyFactory и отключит использование системного прокси.

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

void QNetworkProxy::setCapabilities(QNetworkProxy::Capabilities capabilities)

Устанавливает возможности этого прокси на capabilities.

См. также setType() и capabilities().

[since 5.0] void QNetworkProxy::setHeader(QNetworkRequest::KnownHeaders header, const QVariant &value)

Устанавливает значение известного заголовка header на value, переопределяя все ранее заданные заголовки. Эта операция также устанавливает эквивалентный необработанный HTTP-заголовок.

Если прокси не является типа HttpProxy или HttpCachingProxy, это не повлияет.

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

См. также QNetworkRequest::KnownHeaders, setRawHeader() и header().

void QNetworkProxy::setHostName(const QString &hostName)

Устанавливает имя хоста прокси-сервера на hostName.

См. также hostName(), setPort() и port().

void QNetworkProxy::setPassword(const QString &password)

Устанавливает пароль для аутентификации прокси на password.

См. также user(), setUser() и password().

void QNetworkProxy::setPort(quint16 port)

Устанавливает порт хоста прокси-сервера на port.

См. также hostName(), setHostName() и port().

[since 5.0] void QNetworkProxy::setRawHeader(const QByteArray &headerName, const QByteArray &headerValue)

Устанавливает заголовок headerName со значением headerValue. Если headerName соответствует известному заголовку (см. QNetworkRequest::KnownHeaders), необработанный формат будет распарсен, и соответствующий заголовок также будет установлен.

Например:

request.setRawHeader(QByteArray("Last-Modified"), QByteArray("Sun, 06 Nov 1994 08:49:37 GMT"));

также установит известный заголовок LastModifiedHeader в объект QDateTime распарсенной даты.

Если прокси не является типа HttpProxy или HttpCachingProxy, это не повлияет.

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

См. также QNetworkRequest::KnownHeaders, setHeader(), hasRawHeader() и rawHeader().

void QNetworkProxy::setType(QNetworkProxy::ProxyType type)

Устанавливает тип прокси для этого экземпляра на type.

Обратите внимание, что изменение типа прокси не изменяет набор возможностей этого объекта QNetworkProxy, если какие-либо возможности были установлены с помощью setCapabilities().

См. также type() и setCapabilities().

void QNetworkProxy::setUser(const QString &user)

Устанавливает имя пользователя для аутентификации прокси на user.

См. также user(), setPassword() и password().

[since 5.0] void QNetworkProxy::swap(QNetworkProxy &other)

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

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

QNetworkProxy::ProxyType QNetworkProxy::type() const

Возвращает тип прокси для этого экземпляра.

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

QString QNetworkProxy::user() const

Возвращает имя пользователя, используемое для аутентификации.

См. также setUser(), setPassword() и password().

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

Сравнивает значение этого сетевого прокси-сервера с other и возвращает true, если они отличаются.

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

Сравнивает значение этого сетевого прокси-сервера с other и возвращает true, если они равны (одинаковый тип прокси, сервер, а также имя пользователя и пароль).