QNetworkReply Class Reference
[QtNetwork module]

Detailed Description

The QNetworkReply class contains the data and headers for a request posted with QNetworkAccessManager

The QNetworkReply class contains the data and meta data related to a request posted with QNetworkAccessManager. Like QNetworkRequest, it contains a URL and headers (both in parsed and raw form), some information about the reply's state and the contents of the reply itself.

QNetworkReply is a sequential-access QIODevice, which means that once data is read from the object, it no longer kept by the device. It is therefore the application's responsibility to keep this data if it needs to. Whenever more data is received from the network and processed, the readyRead() signal is emitted.

The downloadProgress() signal is also emitted when data is received, but the number of bytes contained in it may not represent the actual bytes received, if any transformation is done to the contents (for example, decompressing and removing the protocol overhead).

Even though QNetworkReply is a QIODevice connected to the contents of the reply, it also emits the uploadProgress() signal, which indicates the progress of the upload for operations that have such content.

See also QNetworkRequest and QNetworkAccessManager.

Member Type Documentation

enum QNetworkReply::NetworkError

Indicates all possible error conditions found during the processing of the request.

See also error().

Member Function Documentation

QNetworkReply::QNetworkReply ( QObject * parent = 0 )   [protected]

Creates a QNetworkReply object with parent parent.

You cannot directly instantiate QNetworkReply objects. Use QNetworkAccessManager functions to do that.

QNetworkReply::~QNetworkReply ()

Disposes of this reply and frees any resources associated with it. If any network connections are still open, they will be closed.

See also abort() and close().

void QNetworkReply::abort ()   [pure virtual]

Aborts the operation immediately and close down any network connections still open. Uploads still in progress are also aborted.

See also close().

QVariant QNetworkReply::attribute ( QNetworkRequest::Attribute code ) const

Returns the attribute associated with the code code. If the attribute has not been set, it returns an invalid QVariant (type QVariant::Null).

You can expect the default values listed in QNetworkRequest::Attribute to be applied to the values returned by this function.

See also setAttribute() and QNetworkRequest::Attribute.

void QNetworkReply::close ()   [virtual]

Closes this device for reading. Unread data is discarded, but the network resources are not discarded until they are finished. In particular, if any upload is in progress, it will continue until it is done.

The finished() signal is emitted when all operations are over and the network resources are freed.

Reimplemented from QIODevice.

See also abort() and finished().

void QNetworkReply::downloadProgress ( qint64 bytesReceived, qint64 bytesTotal )   [signal]

This signal is emitted to indicate the progress of the download part of this network request, if there's any. If there's no download associated with this request, this signal will be emitted once with 0 as the value of both bytesReceived and bytesTotal.

The bytesReceived parameter indicates the number of bytes received, while bytesTotal indicates the total number of bytes expected to be downloaded. If the number of bytes to be downloaded is not known, bytesTotal will be -1.

The download is finished when bytesReceived is equal to bytesTotal. At that time, bytesTotal will not be -1.

This signal is suitable to connecting to QProgressBar::setValue() to update the QProgressBar that provides user feedback.

Note that the values of both bytesReceived and bytesTotal may be different from size(), the total number of bytes obtained through read() or readAll(), or the value of the header(ContentLengthHeader). The reason for that is that there may be protocol overhead or the data may be compressed during the download.

See also uploadProgress() and bytesAvailable().

NetworkError QNetworkReply::error () const

Returns the error that was found during the processing of this request. If no error was found, returns NoError.

See also setError().

void QNetworkReply::error ( QNetworkReply::NetworkError code )   [signal]

This is an overloaded member function, provided for convenience.

This signal is emitted when the reply detects an error in processing. The finished() signal will probably follow, indicating that the connection is over.

The code parameter contains the code of the error that was detected. Call errorString() to obtain a textual representation of the error condition.

See also error() and errorString().

void QNetworkReply::finished ()   [signal]

This signal is emitted when the reply has finished processing. After this signal is emitted, there will be no more updates to the reply's data or metadata.

Unless close() has been called, the reply will be still be opened for reading, so the data can be retrieved by calls to read() or readAll(). In particular, if no calls to read() were made as a result of readyRead(), a call to readAll() will retrieve the full contents in a QByteArray.

This signal is emitted in tandem with QNetworkAccessManager::finished() where that signal's reply parameter is this object.

See also QNetworkAccessManager::finished().

bool QNetworkReply::hasRawHeader ( const QByteArray & headerName ) const

Returns true if the raw header of name headerName was sent by the remote server

See also rawHeader().

QVariant QNetworkReply::header ( QNetworkRequest::KnownHeaders header ) const

Returns the value of the known header header, if that header was sent by the remote server. If the header was not sent, returns an invalid QVariant.

See also rawHeader(), setHeader(), and QNetworkRequest::header().

void QNetworkReply::ignoreSslErrors ()   [virtual slot]

If this function is called, SSL errors related to network connection will be ignored, including certificate validation errors.

Note that calling this function without restraint may pose a security risk for your application. Use it with care.

This function can be called from the slot connected to the sslErrors() signal, which indicates which errors were found.

See also sslConfiguration() and sslErrors().

QNetworkAccessManager * QNetworkReply::manager () const

Returns the QNetworkAccessManager that was used to create this QNetworkReply object. Initially, it is also the parent object.

void QNetworkReply::metaDataChanged ()   [signal]

FIXME: Update name?

This signal is emitted whenever the metadata in this reply changes. metadata is any information that is not the content (data) itself, including the network headers. In the majority of cases, the metadata will be known fully by the time the first byte of data is received. However, it is possible to receive updates of headers or other metadata during the processing of the data.

See also header(), rawHeaderList(), rawHeader(), and hasRawHeader().

QNetworkAccessManager::Operation QNetworkReply::operation () const

Returns the operation that was posted for this reply.

See also setOperation().

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

Returns the raw contents of the header headerName as sent by the remote server. If there is no such header, returns an empty byte array, which may be indistinguishable from an empty header. Use hasRawHeader() to verify if the server sent such header field.

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

QList<QByteArray> QNetworkReply::rawHeaderList () const

Returns a list of headers fields that were sent by the remote server, in the order that they were sent. Duplicate headers are merged together and take place of the latter duplicate.

qint64 QNetworkReply::readBufferSize () const

Returns the size of the read buffer, in bytes.

See also setReadBufferSize().

QNetworkRequest QNetworkReply::request () const

Returns the request that was posted for this reply. In special, note that the URL for the request may be different than that of the reply.

See also QNetworkRequest::url(), url(), and setRequest().

void QNetworkReply::setAttribute ( QNetworkRequest::Attribute code, const QVariant & value )   [protected]

Sets the attribute code to have value value. If code was previously set, it will be overridden. If value is an invalid QVariant, the attribute will be unset.

See also attribute() and QNetworkRequest::setAttribute().

void QNetworkReply::setError ( NetworkError errorCode, const QString & errorString )   [protected]

Sets the error condition to be errorCode. The human-readable message is set with errorString.

Calling setError() does not emit the error(QNetworkReply::NetworkError) signal.

See also error() and errorString().

void QNetworkReply::setHeader ( QNetworkRequest::KnownHeaders header, const QVariant & value )   [protected]

Sets the known header header to be of value value. The corresponding raw form of the header will be set as well.

See also header(), setRawHeader(), and QNetworkRequest::setHeader().

void QNetworkReply::setOperation ( QNetworkAccessManager::Operation operation )   [protected]

Sets the associated operation for this object to be operation. This value will be returned by operation().

Note: the operation should be set when this object is created and not changed again.

See also operation() and setRequest().

void QNetworkReply::setRawHeader ( const QByteArray & headerName, const QByteArray & value )   [protected]

Sets the raw header headerName to be of value value. If headerName was previously set, it is overridden. Multiple HTTP headers of the same name are functionally equivalent to one single header with the values concatenated, separated by commas.

If headerName matches a known header, the value value will be parsed and the corresponding parsed form will also be set.

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

void QNetworkReply::setReadBufferSize ( qint64 size )   [virtual]

Sets the size of the read buffer to be size bytes. The read buffer is the buffer that holds data that is being downloaded off the network, before it is read with QIODevice::read(). Setting the buffer size to 0 will make the buffer unlimited in size.

QNetworkReply will try to stop reading from the network once this buffer is full (i.e., bytesAvailable() returns size or more), thus causing the download to throttle down as well. If the buffer is not limited in size, QNetworkReply will try to download as fast as possible from the network.

Unlike QAbstractSocket::setReadBufferSize(), QNetworkReply cannot guarantee precision in the read buffer size. That is, bytesAvailable() can return more than size.

See also readBufferSize().

void QNetworkReply::setRequest ( const QNetworkRequest & request )   [protected]

Sets the associated request for this object to be request. This value will be returned by request().

Note: the request should be set when this object is created and not changed again.

See also request() and setOperation().

void QNetworkReply::setSslConfiguration ( const QSslConfiguration & config )

Sets the SSL configuration for the network connection associated with this request, if possible, to be that of config.

See also sslConfiguration().

void QNetworkReply::setUrl ( const QUrl & url )   [protected]

Sets the URL being processed to be url. Normally, the URL matches that of the request that was posted, but for a variety of reasons it can be different (for example, a file path being made absolute or canonical).

See also url(), request(), and QNetworkRequest::url().

QSslConfiguration QNetworkReply::sslConfiguration () const

Returns the SSL configuration and state associated with this reply, if SSL was used. It will contain the remote server's certificate, its certificate chain leading to the Certificate Authority as well as the encryption ciphers in use.

The peer's certificate and its certificate chain will be known by the time sslErrors() is emitted, if it's emitted.

See also setSslConfiguration().

void QNetworkReply::sslErrors ( const QList<QSslError> & errors )   [signal]

This signal is emitted if the SSL/TLS session encountered errors during the set up, including certificate verification errors. The errors parameter contains the list of errors.

To indicate that the errors are not fatal and that the connection should proceed, the ignoreSslErrors() function should be called from the slot connected to this signal. If it is not called, the SSL session will be torn down before any data is exchanged (including the URL).

This signal can be used to display an error message to the user indicating that security may be compromised and display the SSL settings (see sslConfiguration() to obtain it). If the user decides to proceed after analyzing the remote certificate, the slot should call ignoreSslErrors().

See also QSslSocket::sslErrors(), QNetworkAccessManager::sslErrors(), sslConfiguration(), and ignoreSslErrors().

void QNetworkReply::uploadProgress ( qint64 bytesSent, qint64 bytesTotal )   [signal]

This signal is emitted to indicate the progress of the upload part of this network request, if there's any. If there's no upload associated with this request, this signal will not be emitted.

The bytesSent parameter indicates the number of bytes uploaded, while bytesTotal indicates the total number of bytes to be uploaded. If the number of bytes to be uploaded could not be determined, bytesTotal will be -1.

The upload is finished when bytesSent is equal to bytesTotal. At that time, bytesTotal will not be -1.

This signal is suitable to connecting to QProgressBar::setValue() to update the QProgressBar that provides user feedback.

See also downloadProgress().

QUrl QNetworkReply::url () const

Returns the URL of the content downloaded or uploaded. Note that the URL may be different from that of the original request.

See also request(), setUrl(), and QNetworkRequest::url().