QNetworkProxy Class

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

serverSocket->setProxy(QNetworkProxy::NoProxy);

Member Function Documentation

QNetworkProxy::QNetworkProxy(const QNetworkProxy &other)

Constructs a copy of other.

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

Constructs a QNetworkProxy with type, hostName, port, user and password.

The default capabilities for proxy type type are set automatically.

See also capabilities().

QNetworkProxy::QNetworkProxy()

Constructs a QNetworkProxy with DefaultProxy type.

The proxy type is determined by applicationProxy(), which defaults to NoProxy or a system-wide proxy if one is configured.

See also setType() and setApplicationProxy().

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

Assigns the value of the network proxy other to this network proxy.

QNetworkProxy::~QNetworkProxy()

Destroys the QNetworkProxy object.

[static] QNetworkProxy QNetworkProxy::applicationProxy()

Returns the application level network proxying.

If a QAbstractSocket or QTcpSocket has the QNetworkProxy::DefaultProxy type, then the QNetworkProxy returned by this function is used.

See also QNetworkProxyFactory, setApplicationProxy(), QAbstractSocket::proxy(), and QTcpServer::proxy().

QNetworkProxy::Capabilities QNetworkProxy::capabilities() const

Returns the capabilities of this proxy server.

See also setCapabilities() and type().

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

Returns true if the raw header headerName is in use for this proxy. Returns false if the proxy is not of type HttpProxy or HttpCachingProxy.

This function was introduced in Qt 5.0.

See also rawHeader() and setRawHeader().

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

Returns the value of the known network header header if it is in use for this proxy. If it is not present, returns QVariant() (i.e., an invalid variant).

This function was introduced in Qt 5.0.

See also QNetworkRequest::KnownHeaders, rawHeader(), and setHeader().

QString QNetworkProxy::hostName() const

Returns the host name of the proxy host.

See also setHostName(), setPort(), and port().

bool QNetworkProxy::isCachingProxy() const

Returns true if this proxy supports the QNetworkProxy::CachingCapability capability.

In Qt 4.4, the capability was tied to the proxy type, but since Qt 4.5 it is possible to remove the capability of caching from a proxy by calling setCapabilities().

See also capabilities(), type(), and isTransparentProxy().

bool QNetworkProxy::isTransparentProxy() const

Returns true if this proxy supports transparent tunneling of TCP connections. This matches the QNetworkProxy::TunnelingCapability capability.

In Qt 4.4, the capability was tied to the proxy type, but since Qt 4.5 it is possible to remove the capability of caching from a proxy by calling setCapabilities().

See also capabilities(), type(), and isCachingProxy().

QString QNetworkProxy::password() const

Returns the password used for authentication.

See also user(), setPassword(), and setUser().

quint16 QNetworkProxy::port() const

Returns the port of the proxy host.

See also setHostName(), setPort(), and hostName().

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

Returns the raw form of header headerName. If no such header is present or the proxy is not of type HttpProxy or HttpCachingProxy, an empty QByteArray is returned, which may be indistinguishable from a header that is present but has no content (use hasRawHeader() to find out if the header exists or not).

Raw headers can be set with setRawHeader() or with setHeader().

This function was introduced in Qt 5.0.

See also header() and setRawHeader().

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

Returns a list of all raw headers that are set in this network proxy. The list is in the order that the headers were set.

If the proxy is not of type HttpProxy or HttpCachingProxy an empty QList is returned.

This function was introduced in Qt 5.0.

See also hasRawHeader() and rawHeader().

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

Sets the application level network proxying to be networkProxy.

If a QAbstractSocket or QTcpSocket has the QNetworkProxy::DefaultProxy type, then the QNetworkProxy set with this function is used. If you want more flexibility in determining which proxy is used, use the QNetworkProxyFactory class.

Setting a default proxy value with this function will override the application proxy factory set with QNetworkProxyFactory::setApplicationProxyFactory, and disable the use of a system proxy.

See also QNetworkProxyFactory, applicationProxy(), QAbstractSocket::setProxy(), and QTcpServer::setProxy().

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

Sets the capabilities of this proxy to capabilities.

See also setType() and capabilities().

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

Sets the value of the known header header to be value, overriding any previously set headers. This operation also sets the equivalent raw HTTP header.

If the proxy is not of type HttpProxy or HttpCachingProxy this has no effect.

This function was introduced in Qt 5.0.

See also QNetworkRequest::KnownHeaders, setRawHeader(), and header().

void QNetworkProxy::setHostName(const QString &hostName)

Sets the host name of the proxy host to be hostName.

See also hostName(), setPort(), and port().

void QNetworkProxy::setPassword(const QString &password)

Sets the password for proxy authentication to be password.

See also user(), setUser(), and password().

void QNetworkProxy::setPort(quint16 port)

Sets the port of the proxy host to be port.

See also hostName(), setHostName(), and port().

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

Sets the header headerName to be of value headerValue. If headerName corresponds to a known header (see QNetworkRequest::KnownHeaders), the raw format will be parsed and the corresponding "cooked" header will be set as well.

For example:

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

will also set the known header LastModifiedHeader to be the QDateTime object of the parsed date.

If the proxy is not of type HttpProxy or HttpCachingProxy this has no effect.

This function was introduced in Qt 5.0.

See also QNetworkRequest::KnownHeaders, setHeader(), hasRawHeader(), and rawHeader().

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

Sets the proxy type for this instance to be type.

Note that changing the type of a proxy does not change the set of capabilities this QNetworkProxy object holds if any capabilities have been set with setCapabilities().

See also type() and setCapabilities().

void QNetworkProxy::setUser(const QString &user)

Sets the user name for proxy authentication to be user.

See also user(), setPassword(), and password().

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

Swaps this network proxy instance with other. This function is very fast and never fails.

This function was introduced in Qt 5.0.

QNetworkProxy::ProxyType QNetworkProxy::type() const

Returns the proxy type for this instance.

See also setType().

QString QNetworkProxy::user() const

Returns the user name used for authentication.

See also setUser(), setPassword(), and password().

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

Compares the value of this network proxy to other and returns true if they differ.

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

Compares the value of this network proxy to other and returns true if they are equal (same proxy type, server as well as username and password)