QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Slots | Signals | Public Member Functions | Static Public Member Functions | List of all members
QgsHttpTransaction Class Reference

HTTP request/response manager that is redirect-aware. More...

#include <qgshttptransaction.h>

Inheritance diagram for QgsHttpTransaction:
Inheritance graph

Public Slots

void dataStarted (int id)
void dataHeaderReceived (const QHttpResponseHeader &resp)
void dataReceived (const QHttpResponseHeader &resp)
void dataProgress (int done, int total)
void dataFinished (int id, bool error)
void transactionFinished (bool error)
void dataStateChanged (int state)
void networkTimedOut ()
void abort ()
 Aborts the current transaction. More...


void setProgress (int done, int total)
 legacy code. More...
void dataReadProgress (int theProgress)
 Signal for progress update. More...
void totalSteps (int theTotalSteps)
 Signal for adjusted number of steps. More...
void statusChanged (QString theStatusQString)
 emit a signal to be caught by qgisapp and display a msg on status bar More...

Public Member Functions

 QgsHttpTransaction (QString uri, QString proxyHost=QString(), int proxyPort=80, QString proxyUser=QString(), QString proxyPass=QString(), QNetworkProxy::ProxyType proxyType=QNetworkProxy::NoProxy, QString userName=QString(), QString password=QString())
 Constructor. More...
virtual ~QgsHttpTransaction ()
 Destructor. More...
void getAsynchronously ()
bool getSynchronously (QByteArray &respondedContent, int redirections=0, const QByteArray *postData=0)
 Gets the response synchronously. More...
QString responseContentType ()
QString errorString ()
 If an operation returns 0 (e.g. More...
void setCredentials (const QString &username, const QString &password)
 Set the credentials (username and password) More...
int networkTimeout () const
 Returns the network timeout in msec. More...
void setNetworkTimeout (int msec)
 Sets the network timeout in milliseconds. More...

Static Public Member Functions

static bool applyProxySettings (QHttp &http, const QString &url)
 Apply proxy settings from QSettings to a http object. More...

Detailed Description

HTTP request/response manager that is redirect-aware.

This class extends the Qt QHttp concept by being able to recognise and respond to redirection responses (e.g. HTTP code 302)

Constructor & Destructor Documentation

QgsHttpTransaction::QgsHttpTransaction ( QString  uri,
QString  proxyHost = QString(),
int  proxyPort = 80,
QString  proxyUser = QString(),
QString  proxyPass = QString(),
QNetworkProxy::ProxyType  proxyType = QNetworkProxy::NoProxy,
QString  userName = QString(),
QString  password = QString() 


userName and password added in 1.1
QgsHttpTransaction::~QgsHttpTransaction ( )


Member Function Documentation

void QgsHttpTransaction::abort ( )

Aborts the current transaction.

bool QgsHttpTransaction::applyProxySettings ( QHttp &  http,
const QString &  url 

Apply proxy settings from QSettings to a http object.

true if proxy settings was applied, false else
void QgsHttpTransaction::dataFinished ( int  id,
bool  error 
void QgsHttpTransaction::dataHeaderReceived ( const QHttpResponseHeader &  resp)
void QgsHttpTransaction::dataProgress ( int  done,
int  total 
void QgsHttpTransaction::dataReadProgress ( int  theProgress)

Signal for progress update.

void QgsHttpTransaction::dataReceived ( const QHttpResponseHeader &  resp)
void QgsHttpTransaction::dataStarted ( int  id)
void QgsHttpTransaction::dataStateChanged ( int  state)
QString QgsHttpTransaction::errorString ( )

If an operation returns 0 (e.g.

getSynchronously()), this function returns the text of the error associated with the failure. Interactive users of this provider can then, for example, call a QMessageBox to display the contents.

void QgsHttpTransaction::getAsynchronously ( )
bool QgsHttpTransaction::getSynchronously ( QByteArray &  respondedContent,
int  redirections = 0,
const QByteArray *  postData = 0 

Gets the response synchronously.

Note that signals will still be emitted while in this function.

The function returns false if there is an error while getting the response.

[out]respondedContentis replaced with the new content.
[in]redirectionsis used to measure how many http redirections we've been through. Clients typically don't need to set this.
postDatadata to send with the http message. This is only used for HTTP POST. If 0 then the request is done with HTTP GET.
true in case of success
void QgsHttpTransaction::networkTimedOut ( )
int QgsHttpTransaction::networkTimeout ( ) const

Returns the network timeout in msec.

QString QgsHttpTransaction::responseContentType ( )
void QgsHttpTransaction::setCredentials ( const QString &  username,
const QString &  password 

Set the credentials (username and password)

added in 1.1
void QgsHttpTransaction::setNetworkTimeout ( int  msec)

Sets the network timeout in milliseconds.

void QgsHttpTransaction::setProgress ( int  done,
int  total 

legacy code.

This signal is currently not emitted and only kept for API compatibility

void QgsHttpTransaction::statusChanged ( QString  theStatusQString)

emit a signal to be caught by qgisapp and display a msg on status bar

void QgsHttpTransaction::totalSteps ( int  theTotalSteps)

Signal for adjusted number of steps.

void QgsHttpTransaction::transactionFinished ( bool  error)

The documentation for this class was generated from the following files: