Qt 4.4: QNetworkAccessManager Class Reference

|  | Home · All Classes · Main Classes · Grouped Classes · Modules · Functions |

# QNetworkAccessManager Class Reference
[QtNetwork module]

The QNetworkAccessManager class allows the application to post network requests and receive replies More...

     #include <QNetworkAccessManager>

Inherits QObject.

Inherited by QPatternist::URILoader.

Note: All the functions in this class are reentrant.

This class was introduced in Qt 4.4.

- List of all members, including inherited members

### Public Types

- enum Operation { HeadOperation, GetOperation, PutOperation, PostOperation }

### Public Functions

- QNetworkAccessManager ( QObject * parent = 0 )
- ~QNetworkAccessManager ()
- QNetworkCookieJar * cookieJar () const
- QNetworkReply * get ( const QNetworkRequest & request )
- QNetworkReply * head ( const QNetworkRequest & request )
- QNetworkReply * post ( const QNetworkRequest & request, QIODevice * data )
- QNetworkReply * post ( const QNetworkRequest & request, const QByteArray & data )
- QNetworkProxy proxy () const
- QNetworkReply * put ( const QNetworkRequest & request, QIODevice * data )
- QNetworkReply * put ( const QNetworkRequest & request, const QByteArray & data )
- void setCookieJar ( QNetworkCookieJar * cookieJar )
- void setProxy ( const QNetworkProxy & proxy )

- 29 public functions inherited from QObject

### Signals

- void authenticationRequired ( QNetworkReply * reply, QAuthenticator * authenticator )
- void finished ( QNetworkReply * reply )
- void proxyAuthenticationRequired ( const QNetworkProxy & proxy, QAuthenticator * authenticator )
- void sslErrors ( QNetworkReply * reply, const QList<QSslError> & errors )

- 1 signal inherited from QObject

### Protected Functions

- virtual QNetworkReply * createRequest ( Operation op, const QNetworkRequest & req, QIODevice * outgoingData = 0 )

- 7 protected functions inherited from QObject

### Additional Inherited Members

- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 5 static public members inherited from QObject

## Detailed Description

The QNetworkAccessManager class allows the application to post network requests and receive replies

The Network Access API is constructed around one QNetworkAccessManager object, which holds the common configuration and settings for the requests sent. It contains the proxy and cache configuration, as well as the signals related to such issues and reply signals.

Once a QNetworkAccessManager object has been created, the application can send requests over the network through that object. The methods in QNetworkAccessManager take a request and optionally some data to be uploaded and return a QNetworkReply object. The returned object is where most of the signals as well as the downloaded data are posted.

A simple download off the network could be accomplished with:

             QNetworkAccessManager *manager = new QNetworkAccessManager(this);
             connect(manager, SIGNAL(finished(QNetworkReply*)),
                     this, SLOT(replyFinished(QNetworkReply*)));

             manager->get(QNetworkRequest("http://www.trolltech.com"));

When the `replyFinished` slot above is called, the parameter it takes is the QNetworkReply object containing the downloaded data as well as meta-data (headers, etc.).

\b Note: The slot is responsible for deleting the object at that point.

A more involved example, assuming the manager is already existent, can be:

             QNetworkRequest request;
             request.setUrl("http://www.trolltech.com");
             request.setRawHeader("User-Agent", "MyOwnBrowser 1.0");

             QNetworkReply *reply = manager->get(request);
             connect(reply, SIGNAL(readyRead()), this, SLOT(slotReadyRead()));
             connect(reply, SIGNAL(error(QNetworkReply::NetworkError)),
                     this, SLOT(slotError(QNetworkReply::NetworkError)));
             connect(reply, SIGNAL(sslErrors(QList<QSslError>)),
                     this, SLOT(slotSslErrors(QList<QSslError)));

See also QNetworkRequest, QNetworkReply, and QNetworkProxy.

## Member Type Documentation

### enum QNetworkAccessManager::Operation

Indicates the operation this reply is processing.

Constant | Value | Description
--- | --- | ---
`QNetworkAccessManager::HeadOperation` | `1` | retrieve headers operation (created with head())
`QNetworkAccessManager::GetOperation` | `2` | retrieve headers and download contents (created with get())
`QNetworkAccessManager::PutOperation` | `3` | upload contents operation (created with put())
`QNetworkAccessManager::PostOperation` | `4` | send the contents of an HTML form for processing via HTTP POST (created with post())

See also QNetworkReply::operation().

## Member Function Documentation

### QNetworkAccessManager::QNetworkAccessManager ( QObject * parent = 0 )

Constructs a QNetworkAccessManager object that is the center of the Network Access API and sets parent as the parent object.

### QNetworkAccessManager::~QNetworkAccessManager ()

Destroys the QNetworkAccessManager object and frees up any resources. Note that QNetworkReply objects that are returned from this class have this object set as their parents, which means that they will be deleted along with it if you don't call QObject::setParent() on them.

### void QNetworkAccessManager::authenticationRequired ( QNetworkReply * reply, QAuthenticator * authenticator ) `[signal]`

This signal is emitted whenever a final server requests authentication before it delivers the requested contents. The slot connected to this signal should fill the credentials for the contents (which can be determined by inspecting the reply object) in the authenticator object.

QNetworkAccessManager will cache the credentials internally and will send the same values if the server requires authentication again, without emitting the authenticationRequired() signal. If it rejects the credentials, this signal will be emitted again.

See also proxyAuthenticationRequired().

### QNetworkCookieJar * QNetworkAccessManager::cookieJar () const

Returns the QNetworkCookieJar that is used to store cookies obtained from the network as well as cookies that are about to be sent.

See also setCookieJar().

### QNetworkReply * QNetworkAccessManager::createRequest ( Operation op, const QNetworkRequest & req, QIODevice * outgoingData = 0 ) `[virtual protected]`

Returns a new QNetworkReply object to handle the operation op and request req. The device outgoingData is always 0 for Get and Head requests, but is the value passed to post() and put() in those operations (the QByteArray variants will pass a QBuffer object).

The default implementation calls QNetworkCookieJar::cookiesForUrl() on the cookie jar set with setCookieJar() to obtain the cookies to be sent to the remote server.

The returned object must be in an open state.

### void QNetworkAccessManager::finished ( QNetworkReply * reply ) `[signal]`

This signal is emitted whenever a pending network reply is finished. The reply parameter will contain a pointer to the reply that has just finished. This signal is emitted in tandem with the QNetworkReply::finished() signal.

See QNetworkReply::finished() for information on the status that the object will be in.

See also QNetworkReply::finished() and QNetworkReply::error().

### QNetworkReply * QNetworkAccessManager::get ( const QNetworkRequest & request )

This function is used to post a request to obtain the contents of the target request. It will cause the contents to be downloaded, along with the headers associated with it. It returns a new QNetworkReply object opened for reading which emits its QIODevice::readyRead() signal whenever new data arrives.

See also post() and put().

### QNetworkReply * QNetworkAccessManager::head ( const QNetworkRequest & request )

This function is used to post a request to obtain the network headers for request. It takes its name after the HTTP request associated (HEAD). It returns a new QNetworkReply object which will contain such headers.

### QNetworkReply * QNetworkAccessManager::post ( const QNetworkRequest & request, QIODevice * data )

This function is used to send an HTTP POST request to the destination specified by request. The contents of the data device will be uploaded to the server.

data must be opened for reading when this function is called and must remain valid until the finished() signal is emitted for this reply.

The returned QNetworkReply object will be open for reading and will contain the reply sent by the server to the POST request.

Note: sending a POST request on protocols other than HTTP and HTTPS is undefined and will probably fail.

See also get() and put().

### QNetworkReply * QNetworkAccessManager::post ( const QNetworkRequest & request, const QByteArray & data )

This is an overloaded member function, provided for convenience.

This function sends the contents of the data byte array to the destination specified by request.

### QNetworkProxy QNetworkAccessManager::proxy () const

Returns the QNetworkProxy that the requests sent using this QNetworkAccessManager object will use. By default, QNetworkAccessManager uses the application global proxy settings.

See also setProxy() and proxyAuthenticationRequired().

### void QNetworkAccessManager::proxyAuthenticationRequired ( const QNetworkProxy & proxy, QAuthenticator * authenticator ) `[signal]`

This signal is emitted whenever a proxy requests authentication and QNetworkAccessManager cannot find a valid, cached credential. The slot connected to this signal should fill in the credentials for the proxy proxy in the authenticator object.

QNetworkAccessManager will cache the credentials internally. The next time the proxy requests authentication, QNetworkAccessManager will automatically send the same credential without emitting the proxyAuthenticationRequired signal again.

If the proxy rejects the credentials, QNetworkAccessManager will emit the signal again.

See also proxy(), setProxy(), and authenticationRequired().

### QNetworkReply * QNetworkAccessManager::put ( const QNetworkRequest & request, QIODevice * data )

This function is used to upload the contents of data to the destination request.

data must be opened for reading when this function is called and must remain valid until the finished() signal is emitted for this reply.

The returned QNetworkReply object will be open for reply, but whether anything will be available for reading is protocol dependent. For HTTP, the server may send a small HTML page indicating the upload was successful (or not). Other protocols will probably have content in their replies.

For HTTP, this request will send a PUT request, which most servers do not allow. Form upload mechanisms, including that of uploading files through HTML forms, use the POST mechanism.

See also get() and post().

### QNetworkReply * QNetworkAccessManager::put ( const QNetworkRequest & request, const QByteArray & data )

This is an overloaded member function, provided for convenience.

This function sends the contents of the data byte array to the destination specified by request.

### void QNetworkAccessManager::setCookieJar ( QNetworkCookieJar * cookieJar )

Sets the cookie jar that is used by all request sent using this QNetworkAccessManager object to be cookieJar. Use this function to set the cookie jar object to a class that implements further features, like saving the cookies to permanent storage.

Note that QNetworkAccessManager takes ownership of the object cookieJar.

QNetworkAccessManager by default does not implement any cookie policy of its own: it accepts all cookies sent by the server, as long as they are well formed and meet the minimum security requirements (cookie domain matches the request's and cookie path matches the request's). In order to implement your own security policy, override the QNetworkCookieJar::cookiesForUrl() and QNetworkCookieJar::setCookiesFromUrl() virtual functions. Those functions are called by QNetworkAccessManager when it detects a new cookie.

See also cookieJar(), QNetworkCookieJar::cookiesForUrl(), and QNetworkCookieJar::setCookiesFromUrl().

### void QNetworkAccessManager::setProxy ( const QNetworkProxy & proxy )

Sets the proxy to be used in future requests to be proxy. This does not affect requests that have already been sent. The proxyAuthenticationRequired() signal will be emitted if the proxy requests authentication.

See also proxy() and proxyAuthenticationRequired().

### void QNetworkAccessManager::sslErrors ( QNetworkReply * reply, 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 and reply is the QNetworkReply that is encountering these errors.

To indicate that the errors are not fatal and that the connection should proceed, the QNetworkReply::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(), QNetworkReply::sslErrors(), QNetworkReply::sslConfiguration(), and QNetworkReply::ignoreSslErrors().