Home · All Classes · Modules

QNetworkRequest Class Reference
^{[QtNetwork module]}

The QNetworkRequest class holds a request to be sent with QNetworkAccessManager. More...

Types

• enum Attribute { HttpStatusCodeAttribute, HttpReasonPhraseAttribute, RedirectionTargetAttribute, ConnectionEncryptedAttribute, ..., UserMax }
• enum CacheLoadControl { AlwaysNetwork, PreferNetwork, PreferCache, AlwaysCache }
• enum KnownHeaders { ContentTypeHeader, ContentLengthHeader, LocationHeader, LastModifiedHeader, ..., ContentDispositionHeader }
• enum LoadControl { Automatic, Manual }
• enum Priority { HighPriority, NormalPriority, LowPriority }

Methods

• __init__ (self, QUrl url = QUrl())
• __init__ (self, QNetworkRequest other)
• QVariant attribute (self, Attribute code, QVariant defaultValue = QVariant())
• bool hasRawHeader (self, QByteArray headerName)
• QVariant header (self, KnownHeaders header)
• QObject originatingObject (self)
• Priority priority (self)
• QByteArray rawHeader (self, QByteArray headerName)
• list-of-QByteArray rawHeaderList (self)
• setAttribute (self, Attribute code, QVariant value)
• setHeader (self, KnownHeaders header, QVariant value)
• setOriginatingObject (self, QObject object)
• setPriority (self, Priority priority)
• setRawHeader (self, QByteArray headerName, QByteArray value)
• setSslConfiguration (self, QSslConfiguration configuration)
• setUrl (self, QUrl url)
• QSslConfiguration sslConfiguration (self)
• QUrl url (self)

Special Methods

• bool __eq__ (self, QNetworkRequest other)
• bool __ne__ (self, QNetworkRequest other)

The QNetworkRequest class holds a request to be sent with QNetworkAccessManager.

QNetworkRequest is part of the Network Access API and is the class holding the information necessary to send a request over the network. It contains a URL and some ancillary information that can be used to modify the request.

Type Documentation

QNetworkRequest.Attribute

Attribute codes for the QNetworkRequest and QNetworkReply.

Attributes are extra meta-data that are used to control the behavior of the request and to pass further information from the reply back to the application. Attributes are also extensible, allowing custom implementations to pass custom values.

The following table explains what the default attribute codes are, the QVariant types associated, the default value if said attribute is missing and whether it's used in requests or replies.

This enum was introduced or modified in Qt 4.7.

QNetworkRequest.CacheLoadControl

Controls the caching mechanism of QNetworkAccessManager.

QNetworkRequest.KnownHeaders

List of known header types that QNetworkRequest parses. Each known header is also represented in raw form with its full HTTP name.

See also header(), setHeader(), rawHeader(), and setRawHeader().

QNetworkRequest.LoadControl

Indicates if an aspect of the request's loading mechanism has been manually overridden, e.g. by QtWebKit.

This enum was introduced or modified in Qt 4.7.

QNetworkRequest.Priority

This enum lists the possible network request priorities.

QNetworkRequest.__init__ (self, QUrl url = QUrl())

Constructs a QNetworkRequest object with url as the URL to be requested.

See also url() and setUrl().

QNetworkRequest.__init__ (self, QNetworkRequest other)

Creates a copy of other.

QVariant QNetworkRequest.attribute (self, Attribute code, QVariant defaultValue = QVariant())

Returns the attribute associated with the code code. If the attribute has not been set, it returns defaultValue.

Note: this function does not apply the defaults listed in QNetworkRequest.Attribute.

See also setAttribute() and QNetworkRequest.Attribute.

bool QNetworkRequest.hasRawHeader (self, QByteArray headerName)

Returns true if the raw header headerName is present in this network request.

See also rawHeader() and setRawHeader().

QVariant QNetworkRequest.header (self, KnownHeaders header)

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

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

QObject QNetworkRequest.originatingObject (self)

Returns a reference to the object that initiated this network request; returns 0 if not set or the object has been destroyed.

This function was introduced in Qt 4.6.

See also setOriginatingObject().

Priority QNetworkRequest.priority (self)

Return the priority of this request.

This function was introduced in Qt 4.7.

See also setPriority().

QByteArray QNetworkRequest.rawHeader (self, QByteArray headerName)

Returns the raw form of header headerName. If no such header is present, 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().

See also header() and setRawHeader().

list-of-QByteArray QNetworkRequest.rawHeaderList (self)

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

See also hasRawHeader() and rawHeader().

QNetworkRequest.setAttribute (self, Attribute code, QVariant value)

Sets the attribute associated with code code to be value value. If the attribute is already set, the previous value is discarded. In special, if value is an invalid QVariant, the attribute is unset.

See also attribute() and QNetworkRequest.Attribute.

QNetworkRequest.setHeader (self, KnownHeaders header, 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.

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

QNetworkRequest.setOriginatingObject (self, QObject object)

Allows setting a reference to the object initiating the request.

For example QtWebKit sets the originating object to the QWebFrame that initiated the request.

This function was introduced in Qt 4.6.

See also originatingObject().

QNetworkRequest.setPriority (self, Priority priority)

Set the priority of this request to priority.

Note: The priority is only a hint to the network access manager. It can use it or not. Currently it is used for HTTP to decide which request should be sent first to a server.

This function was introduced in Qt 4.7.

See also priority().

QNetworkRequest.setRawHeader (self, QByteArray headerName, QByteArray value)

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("Last-Modified", "Sun, 06 Nov 1994 08:49:37 GMT");

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

Note: setting the same header twice overrides the previous setting. To accomplish the behaviour of multiple HTTP headers of the same name, you should concatenate the two values, separating them with a comma (",") and set one single raw header.

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

QNetworkRequest.setSslConfiguration (self, QSslConfiguration configuration)

Sets this network request's SSL configuration to be config. The settings that apply are the private key, the local certificate, the SSL protocol (SSLv2, SSLv3, TLSv1 where applicable), the CA certificates and the ciphers that the SSL backend is allowed to use.

By default, no SSL configuration is set, which allows the backends to choose freely what configuration is best for them.

See also sslConfiguration() and QSslConfiguration.defaultConfiguration().

QNetworkRequest.setUrl (self, QUrl url)

Sets the URL this network request is referring to to be url.

See also url().

QSslConfiguration QNetworkRequest.sslConfiguration (self)

Returns this network request's SSL configuration. By default, no SSL settings are specified.

See also setSslConfiguration().

QUrl QNetworkRequest.url (self)

Returns the URL this network request is referring to.

See also setUrl().

bool QNetworkRequest.__eq__ (self, QNetworkRequest other)

bool QNetworkRequest.__ne__ (self, QNetworkRequest other)