QNetworkProxyQuery¶

PyQt5.QtNetwork.QNetworkProxyQuery

Description¶

The QNetworkProxyQuery class is used to query the proxy settings for a socket.

QNetworkProxyQuery holds the details of a socket being created or request being made. It is used by QNetworkProxy and QNetworkProxyFactory to allow applications to have a more fine-grained control over which proxy servers are used, depending on the details of the query. This allows an application to apply different settings, according to the protocol or destination hostname, for instance.

QNetworkProxyQuery supports the following criteria for selecting the proxy:

the type of query
the local port number to use
the destination host name
the destination port number
the protocol name, such as “http” or “ftp”
the URL being requested

The destination host name is the host in the connection in the case of outgoing connection sockets. It is the hostName parameter passed to QTcpSocket::connectToHost() or the host component of a URL requested with QNetworkRequest.

The destination port number is the requested port to connect to in the case of outgoing sockets, while the local port number is the port the socket wishes to use locally before attempting the external connection. In most cases, the local port number is used by listening sockets only (QTcpSocket) or by datagram sockets (QUdpSocket).

The protocol name is an arbitrary string that indicates the type of connection being attempted. For example, it can match the scheme of a URL, like “http”, “https” and “ftp”. In most cases, the proxy selection will not change depending on the protocol, but this information is provided in case a better choice can be made, like choosing an caching HTTP proxy for HTTP-based connections, but a more powerful SOCKSv5 proxy for all others.

The network configuration specifies which configuration to use, when bearer management is used. For example on a mobile phone the proxy settings are likely to be different for the cellular network vs WLAN.

Some of the criteria may not make sense in all of the types of query. The following table lists the criteria that are most commonly used, according to the type of query.

Query type	Description
TcpSocket	Normal sockets requesting a connection to a remote server, like QTcpSocket. The peer hostname and peer port match the values passed to QTcpSocket::connectToHost(). The local port is usually -1, indicating the socket has no preference in which port should be used. The URL component is not used.
UdpSocket	Datagram-based sockets, which can both send and receive. The local port, remote host or remote port fields can all be used or be left unused, depending on the characteristics of the socket. The URL component is not used.
SctpSocket	Message-oriented sockets requesting a connection to a remote server. The peer hostname and peer port match the values passed to QSctpSocket::connectToHost(). The local port is usually -1, indicating the socket has no preference in which port should be used. The URL component is not used.
TcpServer	Passive server sockets that listen on a port and await incoming connections from the network. Normally, only the local port is used, but the remote address could be used in specific circumstances, for example to indicate which remote host a connection is expected from. The URL component is not used.
UrlRequest	A more high-level request, such as those coming from QNetworkAccessManager. These requests will inevitably use an outgoing TCP socket, but the this query type is provided to indicate that more detailed information is present in the URL component. For ease of implementation, the URL’s host and port are set as the destination address.
SctpServer	Passive server sockets that listen on an SCTP port and await incoming connections from the network. Normally, only the local port is used, but the remote address could be used in specific circumstances, for example to indicate which remote host a connection is expected from. The URL component is not used.

It should be noted that any of the criteria may be missing or unknown (an empty QString for the hostname or protocol name, -1 for the port numbers). If that happens, the functions executing the query should make their best guess or apply some implementation-defined default values.

Enums¶

QueryType

Describes the type of one QNetworkProxyQuery query.

Methods¶

__init__(): TODO

__init__(QNetworkProxyQuery): TODO

__init__(QUrl, type: QueryType = UrlRequest): TODO

__init__(int, protocolTag: str = '', type: QueryType = TcpServer): TODO

__init__(QNetworkConfiguration, QUrl, queryType: QueryType = UrlRequest): TODO

__init__(str, int, protocolTag: str = '', type: QueryType = TcpSocket): TODO

__init__(QNetworkConfiguration, int, protocolTag: str = '', type: QueryType = TcpServer): TODO

__init__(QNetworkConfiguration, str, int, protocolTag: str = '', type: QueryType = TcpSocket): TODO

__eq__(QNetworkProxyQuery) → bool: TODO

localPort() → int: See also

setLocalPort().

__ne__(QNetworkProxyQuery) → bool: TODO

networkConfiguration() → QNetworkConfiguration: See also

setNetworkConfiguration().

peerHostName() → str: See also

setPeerHostName().

peerPort() → int: See also

setPeerPort().

protocolTag() → str: See also

setProtocolTag().

queryType() → QueryType: See also

setQueryType().

setLocalPort(int): See also

localPort().

setNetworkConfiguration(QNetworkConfiguration): See also

networkConfiguration().

setPeerHostName(str): See also

peerHostName().

setPeerPort(int): See also

peerPort().

setProtocolTag(str): See also

protocolTag().

setQueryType(QueryType): See also

queryType().

setUrl(QUrl): See also

url().

swap(QNetworkProxyQuery): TODO

url() → QUrl: See also

setUrl().

Member	Value	Description
SctpServer	TODO	an SCTP server that listens for incoming connections from the network
SctpSocket	TODO	a message-oriented, outgoing SCTP socket
TcpServer	100	a TCP server that listens for incoming connections from the network
TcpSocket	0	a normal, outgoing TCP socket
UdpSocket	1	a datagram-based UDP socket, which could send to multiple destinations
UrlRequest	101	a more complex request which involves loading of a URL