QNetworkRequest Class Reference

Member Function Documentation

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

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

See also url() and setUrl().

QNetworkRequest::QNetworkRequest ( const QNetworkRequest & other )

Creates a copy of other.

QNetworkRequest::~QNetworkRequest ()

Disposes of the QNetworkRequest object.

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

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 ( const QByteArray & headerName ) const

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

See also rawHeader() and setRawHeader().

QVariant QNetworkRequest::header ( KnownHeaders header ) const

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 () 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 also setOriginatingObject().

Priority QNetworkRequest::priority () const

Return the priority of this request.

This function was introduced in Qt 4.7.

See also setPriority().

QByteArray QNetworkRequest::rawHeader ( const QByteArray & headerName ) const

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

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 also hasRawHeader() and rawHeader().

void QNetworkRequest::setAttribute ( Attribute code, const 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.

void QNetworkRequest::setHeader ( 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.

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

void QNetworkRequest::setOriginatingObject ( 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().

void QNetworkRequest::setPriority ( 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().

void QNetworkRequest::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("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().

void QNetworkRequest::setSslConfiguration ( const QSslConfiguration & config )

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

void QNetworkRequest::setUrl ( const QUrl & url )

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

See also url().

QSslConfiguration QNetworkRequest::sslConfiguration () const

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

See also setSslConfiguration().

QUrl QNetworkRequest::url () const

Returns the URL this network request is referring to.

See also setUrl().

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

Returns false if this object is not the same as other.

See also operator==().

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

Creates a copy of other

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

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

See also operator!=().