QGIS API Documentation  2.7.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
[legend]

Public Slots

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

Signals

void dataReadProgress (int theProgress)
 Signal for progress update. More...
 
void setProgress (int done, int total)
 legacy code. More...
 
void statusChanged (QString theStatusQString)
 emit a signal to be caught by qgisapp and display a msg on status bar More...
 
void totalSteps (int theTotalSteps)
 Signal for adjusted number of steps. 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...
 
QString errorString ()
 If an operation returns 0 (e.g. More...
 
void getAsynchronously ()
 
bool getSynchronously (QByteArray &respondedContent, int redirections=0, const QByteArray *postData=0)
 Gets the response synchronously. More...
 
int networkTimeout () const
 Returns the network timeout in msec. More...
 
QString responseContentType ()
 
void setCredentials (const QString &username, const QString &password)
 Set the credentials (username and password) 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)

Definition at line 36 of file qgshttptransaction.h.

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

Constructor.

Definition at line 38 of file qgshttptransaction.cpp.

QgsHttpTransaction::~QgsHttpTransaction ( )
virtual

Destructor.

Definition at line 66 of file qgshttptransaction.cpp.

Member Function Documentation

void QgsHttpTransaction::abort ( )
slot

Aborts the current transaction.

Definition at line 556 of file qgshttptransaction.cpp.

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

Apply proxy settings from QSettings to a http object.

Returns
true if proxy settings was applied, false else

Definition at line 499 of file qgshttptransaction.cpp.

void QgsHttpTransaction::dataFinished ( int  id,
bool  error 
)
slot

Definition at line 334 of file qgshttptransaction.cpp.

void QgsHttpTransaction::dataHeaderReceived ( const QHttpResponseHeader &  resp)
slot

Definition at line 259 of file qgshttptransaction.cpp.

void QgsHttpTransaction::dataProgress ( int  done,
int  total 
)
slot

Definition at line 309 of file qgshttptransaction.cpp.

void QgsHttpTransaction::dataReadProgress ( int  theProgress)
signal

Signal for progress update.

void QgsHttpTransaction::dataReceived ( const QHttpResponseHeader &  resp)
slot

Definition at line 290 of file qgshttptransaction.cpp.

void QgsHttpTransaction::dataStarted ( int  id)
slot

Definition at line 252 of file qgshttptransaction.cpp.

void QgsHttpTransaction::dataStateChanged ( int  state)
slot

Definition at line 428 of file qgshttptransaction.cpp.

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.

Definition at line 494 of file qgshttptransaction.cpp.

void QgsHttpTransaction::getAsynchronously ( )

Definition at line 77 of file qgshttptransaction.cpp.

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.

Parameters
[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.
Returns
true in case of success

Definition at line 84 of file qgshttptransaction.cpp.

void QgsHttpTransaction::networkTimedOut ( )
slot

Definition at line 481 of file qgshttptransaction.cpp.

int QgsHttpTransaction::networkTimeout ( ) const
inline

Returns the network timeout in msec.

Definition at line 94 of file qgshttptransaction.h.

QString QgsHttpTransaction::responseContentType ( )

Definition at line 246 of file qgshttptransaction.cpp.

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

Set the credentials (username and password)

Definition at line 72 of file qgshttptransaction.cpp.

void QgsHttpTransaction::setNetworkTimeout ( int  msec)
inline

Sets the network timeout in milliseconds.

Definition at line 96 of file qgshttptransaction.h.

void QgsHttpTransaction::setProgress ( int  done,
int  total 
)
signal

legacy code.

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

void QgsHttpTransaction::statusChanged ( QString  theStatusQString)
signal

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

void QgsHttpTransaction::totalSteps ( int  theTotalSteps)
signal

Signal for adjusted number of steps.

void QgsHttpTransaction::transactionFinished ( bool  error)
slot

Definition at line 383 of file qgshttptransaction.cpp.


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