QNetworkProxy Class

成员函数文档

QNetworkProxy::QNetworkProxy()

创建一个类型为DefaultProxy 的QNetworkProxy。

代理类型由applicationProxy() 确定，其默认值为NoProxy ，或者如果已配置系统级代理，则为该系统级代理。

另请参阅 setType() 和setApplicationProxy()。

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

使用type 、hostName 、port 、user 和password 构建一个 QNetworkProxy。

代理类型type 的默认功能将自动设置。

另请参阅 capabilities()。

QNetworkProxy::QNetworkProxy(const QNetworkProxy &other)

创建other 的副本。

[noexcept] 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()。

bool QNetworkProxy::hasRawHeader(const QByteArray &headerName) const

如果该代理正在使用原始头文件headerName ，则返回true 。如果该代理不是类型HttpProxy 或HttpCachingProxy ，则返回false 。

另请参阅 rawHeader() 和setRawHeader()。

QVariant QNetworkProxy::header(QNetworkRequest::KnownHeaders header) const

如果该已知网络头header 正在被此代理使用，则返回其值。如果不存在，则返回QVariant()（即一个无效的变体）。

另请参阅 QNetworkRequest::KnownHeaders 、rawHeader() 和setHeader()。

[since 6.8] QHttpHeaders QNetworkProxy::headers() const

返回在此网络请求中设置的请求头。

如果代理类型不是HttpProxy 或HttpCachingProxy ，则返回默认构造的QHttpHeaders 。

该函数在 Qt 6.8 中引入。

另请参阅 setHeaders()。

QString QNetworkProxy::hostName() const

返回代理主机的主机名。

另请参阅 setHostName()、setPort() 以及port()。

bool QNetworkProxy::isCachingProxy() const

如果该代理支持QNetworkProxy::CachingCapability 功能，则返回true 。

在 Qt 4.4 中，该功能与代理类型绑定，但自 Qt 4.5 起，可以通过调用setCapabilities() 来移除代理的缓存功能。

另请参阅 capabilities()、type() 和isTransparentProxy()。

bool QNetworkProxy::isTransparentProxy() const

如果该代理支持 TCP 连接的透明隧道传输，则返回 `true `。这与 `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()。

QByteArray QNetworkProxy::rawHeader(const QByteArray &headerName) const

返回标头headerName 的原始形式。如果不存在该标头，或者代理类型不是HttpProxy 或HttpCachingProxy ，则返回一个空的QByteArray ，这可能与“标头存在但内容为空”的情况无法区分（请使用hasRawHeader()来判断标头是否存在）。

可以通过setRawHeader() 或setHeader() 设置原始标头。

另请参阅 header() 和setRawHeader()。

QList<QByteArray> QNetworkProxy::rawHeaderList() const

返回在此网络代理中设置的所有原始标头的列表。该列表按标头设置的顺序排列。

如果代理类型不是HttpProxy 或HttpCachingProxy ，则返回一个空的QList 。

另请参阅 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()。

void QNetworkProxy::setHeader(QNetworkRequest::KnownHeaders header, const QVariant &value)

将已知标头“header ”的值设置为“value ”，并覆盖之前设置的任何标头。此操作还会设置相应的原始 HTTP 标头。

如果代理类型不是HttpProxy 或HttpCachingProxy ，则此操作无效。

另请参阅 QNetworkRequest::KnownHeaders 、setRawHeader() 和header()。

[since 6.8] void QNetworkProxy::setHeaders(QHttpHeaders &&newHeaders)

将newHeaders 设置为本次网络请求的头部，并覆盖之前设置的任何头部。

如果某些标头与已知标头对应，则会解析其值，并设置相应的解析后格式。

如果代理类型不是HttpProxy 或HttpCachingProxy ，则此操作无效。

此函数在 Qt 6.8 中引入。

另请参阅 headers() 和QNetworkRequest::KnownHeaders 。

[since 6.8] void QNetworkProxy::setHeaders(const QHttpHeaders &newHeaders)

该函数在 Qt 6.8 中引入。

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()。

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 ，则此操作无效。

另请参阅 QNetworkRequest::KnownHeaders 、setHeader()、hasRawHeader() 以及rawHeader()。

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

将此实例的代理类型设置为type 。

请注意，如果已通过setCapabilities() 设置了任何权限，则更改代理的类型不会改变该QNetworkProxy 对象所持有的权限集。

另请参阅 type() 和setCapabilities()。

void QNetworkProxy::setUser(const QString &user)

将代理身份验证的用户名设置为user 。

另请参阅 user()、setPassword() 和password()。

[noexcept] void QNetworkProxy::swap(QNetworkProxy &other)

将此网络代理实例替换为other 。此操作非常快速，且绝不会失败。

QNetworkProxy::ProxyType QNetworkProxy::type() const

返回此实例的代理类型。

另请参阅 setType()。

QString QNetworkProxy::user() const

返回用于身份验证的用户名。

另请参阅 setUser()、setPassword() 和password()。

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

将此网络代理的值与other 进行比较，如果两者不同，则返回true 。

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

将网络代理other 的值分配给此网络代理。

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

将此网络代理的值与other 进行比较，如果两者相等（代理类型、服务器以及用户名和密码均相同），则返回true