Contents

• Public Types
• Public Functions
• Detailed Description

Detailed Description

TheQNetworkRequest class holds a request to be sent withQNetworkAccessManager.

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.

Member Type Documentation

enum QNetworkRequest::Attribute

Attribute codes for theQNetworkRequest andQNetworkReply.

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, theQVariant 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.

enum QNetworkRequest::CacheLoadControl

Controls the caching mechanism ofQNetworkAccessManager.

enum QNetworkRequest::KnownHeaders

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

See alsoheader(),setHeader(),rawHeader(), andsetRawHeader().

enum QNetworkRequest::LoadControl

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

This enum was introduced or modified in Qt 4.7.

enum QNetworkRequest::Priority

This enum lists the possible network request priorities.

This enum was introduced or modified in Qt 4.7.

Member Function Documentation

QNetworkRequest::QNetworkRequest(constQUrl & url = QUrl())

Constructs aQNetworkRequest object withurl as the URL to be requested.

See alsourl() andsetUrl().

QNetworkRequest::QNetworkRequest(constQNetworkRequest & other)

Creates a copy ofother.

QNetworkRequest::~QNetworkRequest()

Disposes of theQNetworkRequest object.

QVariant QNetworkRequest::attribute(Attribute code, constQVariant & defaultValue = QVariant()) const

Returns the attribute associated with the codecode. If the attribute has not been set, it returnsdefaultValue.

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

See alsosetAttribute() andQNetworkRequest::Attribute.

bool QNetworkRequest::hasRawHeader(constQByteArray & headerName) const

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

See alsorawHeader() andsetRawHeader().

QVariant QNetworkRequest::header(KnownHeaders header) const

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

See alsoKnownHeaders,rawHeader(), andsetHeader().

QObject * QNetworkRequest::originatingObject() const

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 alsosetOriginatingObject().

Priority QNetworkRequest::priority() const

Return the priority of this request.

This function was introduced in Qt 4.7.

See alsosetPriority().

QByteArray QNetworkRequest::rawHeader(constQByteArray & headerName) const

Returns the raw form of headerheaderName. If no such header is present, an emptyQByteArray is returned, which may be indistinguishable from a header that is present but has no content (usehasRawHeader() to find out if the header exists or not).

Raw headers can be set withsetRawHeader() or withsetHeader().

See alsoheader() andsetRawHeader().

QList<QByteArray> QNetworkRequest::rawHeaderList() const

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 alsohasRawHeader() andrawHeader().

void QNetworkRequest::setAttribute(Attribute code, constQVariant & value)

Sets the attribute associated with codecode to be valuevalue. If the attribute is already set, the previous value is discarded. In special, ifvalue is an invalidQVariant, the attribute is unset.

See alsoattribute() andQNetworkRequest::Attribute.

void QNetworkRequest::setHeader(KnownHeaders header, constQVariant & value)

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

See alsoKnownHeaders,setRawHeader(), andheader().

void QNetworkRequest::setOriginatingObject(QObject * object)

Allows setting a reference to theobject initiating the request.

For exampleQtWebKit sets the originating object to theQWebFrame that initiated the request.

This function was introduced in Qt 4.6.

See alsooriginatingObject().

void QNetworkRequest::setPriority(Priority priority)

Set the priority of this request topriority.

Note:Thepriority 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 alsopriority().

void QNetworkRequest::setRawHeader(constQByteArray & headerName, constQByteArray & headerValue)

Sets the headerheaderName to be of valueheaderValue. IfheaderName corresponds to a known header (seeQNetworkRequest::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 headerLastModifiedHeader to be theQDateTime 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 alsoKnownHeaders,setHeader(),hasRawHeader(), andrawHeader().

void QNetworkRequest::setSslConfiguration(constQSslConfiguration & config)

Sets this network request's SSL configuration to beconfig. 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 alsosslConfiguration() andQSslConfiguration::defaultConfiguration().

void QNetworkRequest::setUrl(constQUrl & url)

Sets the URL this network request is referring to to beurl.

See alsourl().

QSslConfiguration QNetworkRequest::sslConfiguration() const

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

See alsosetSslConfiguration().

QUrl QNetworkRequest::url() const

Returns the URL this network request is referring to.

See alsosetUrl().

bool QNetworkRequest::operator!=(constQNetworkRequest & other) const

Returns false if this object is not the same asother.

See alsooperator==().

QNetworkRequest & QNetworkRequest::operator=(constQNetworkRequest & other)

Creates a copy ofother

bool QNetworkRequest::operator==(constQNetworkRequest & other) const

Returns true if this object is the same asother (i.e., if they have the same URL, same headers and same meta-data settings).

See alsooperator!=().