|  | Home · All Classes · Modules

# QNetworkProxy Class Reference
[QtNetwork module]

The QNetworkProxy class provides a network layer proxy. More...

### Types

- enum ProxyType { DefaultProxy, Socks5Proxy, NoProxy, HttpProxy }

### Methods

- __init__ (self)
- __init__ (self, ProxyType type, QString hostName = QString(), unsigned long port = 0, QString user = QString(), QString password = QString())
- __init__ (self, QNetworkProxy other)
- QString hostName (self)
- QString password (self)
- unsigned long port (self)
- setHostName (self, QString hostName)
- setPassword (self, QString password)
- setPort (self, unsigned long port)
- setType (self, ProxyType type)
- setUser (self, QString userName)
- ProxyType type (self)
- QString user (self)

### Static Methods

- QNetworkProxy applicationProxy ()
- setApplicationProxy (QNetworkProxy proxy)

## Detailed Description

The QNetworkProxy class provides a network layer proxy.

QNetworkProxy provides the method for configuring network layer proxy support to the Qt network classes. The currently supported classes are QAbstractSocket, QTcpSocket, QUdpSocket, QTcpServer, QHttp and QFtp. The proxy support is designed to be as transparent as possible. This means that existing network-enabled applications that you have written should automatically support network proxy using the following code.

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

An alternative to setting an application wide proxy is to specify the proxy for individual sockets using QAbstractSocket.setProxy() and QTcpServer.setProxy(). In this way, it is possible to disable the use of a proxy for specific sockets using the following code:

     serverSocket->setProxy(QNetworkProxy.NoProxy);

Network proxy is not used if the address used in connectToHost(), bind() or listen() is equivalent to QHostAddress.LocalHost or QHostAddress.LocalHostIPv6.

Each type of proxy support has certain restrictions associated with it. You should read the ProxyType documentation carefully before selecting a proxy type to use.

### SOCKS5

The SOCKS5 support in Qt 4 is based on RFC 1928 and RFC 1929. The supported authentication methods are no authentication and username/password authentication. Both IPv4 and IPv6 are supported, but domain name resolution via the SOCKS server is not supported; i.e. all domain names are resolved locally. There are several things to remember when using SOCKS5 with QUdpSocket and QTcpServer:

With QUdpSocket, a call to bind() may fail with a timeout error. If a port number other than 0 is passed to bind(), it is not guaranteed that it is the specified port that will be used. Use localPort() and localAddress() to get the actual address and port number in use. Because proxied UDP goes through two UDP connections, it is more likely that packets will be dropped.

With QTcpServer a call to listen() may fail with a timeout error. If a port number other than 0 is passed to listen(), then it is not guaranteed that it is the specified port that will be used. Use serverPort() and serverAddress() to get the actual address and port used to listen for connections. SOCKS5 only supports one accepted connection per call to listen(), and each call is likely to result in a different serverPort() being used.

See also QAbstractSocket and QTcpServer.

## Type Documentation

### QNetworkProxy.ProxyType

This enum describes the types of network proxying provided in Qt.

Constant | Value | Description
--- | --- | ---
`QNetworkProxy.DefaultProxy` | `0` | Proxy is determined based on the application proxy set using setApplicationProxy()
`QNetworkProxy.Socks5Proxy` | `1` | Socks5 proxying is used
`QNetworkProxy.NoProxy` | `2` | No proxying is used
`QNetworkProxy.HttpProxy` | `3` | Http proxying is used

While Socks5 proxying works for both Tcp and Udp sockets, Http proxying is limited to Tcp connections. Http proxying also doesn't support binding sockets.

See also setType() and type().

## Method Documentation

### QNetworkProxy.__init__ (self)

Constructs a QNetworkProxy with DefaultProxy type; the proxy type is determined by applicationProxy(), which defaults to NoProxy.

See also setType() and setApplicationProxy().

### QNetworkProxy.__init__ (self, ProxyType type, QString hostName = QString(), unsigned long port = 0, QString user = QString(), QString password = QString())

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

### QNetworkProxy.__init__ (self, QNetworkProxy other)

Constructs a copy of other.

### 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 setApplicationProxy(), QAbstractSocket.proxy(), and QTcpServer.proxy().

### QString QNetworkProxy.hostName (self)

Returns the host name of the proxy host.

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

### QString QNetworkProxy.password (self)

Returns the password used for authentication.

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

### unsigned long QNetworkProxy.port (self)

Returns the port of the proxy host.

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

### QNetworkProxy.setApplicationProxy (QNetworkProxy proxy)

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.

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

### QNetworkProxy.setHostName (self, QString hostName)

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

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

### QNetworkProxy.setPassword (self, QString password)

Sets the password for proxy authentication to be password.

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

### QNetworkProxy.setPort (self, unsigned long port)

Sets the port of the proxy host to be port.

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

### QNetworkProxy.setType (self, ProxyType type)

Sets the proxy type for this instance to be type.

See also type().

### QNetworkProxy.setUser (self, QString userName)

Sets the user name for proxy authentication to be user.

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

### ProxyType QNetworkProxy.type (self)

Returns the proxy type for this instance.

See also setType().

### QString QNetworkProxy.user (self)

Returns the user name used for authentication.

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