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

#include <qgshttptransaction.h>

Public Slots
void	abort ()
	Aborts the current transaction.
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.
void	setProgress (int done, int total)
	legacy code.
void	statusChanged (QString theStatusQString)
	emit a signal to be caught by qgisapp and display a msg on status bar
void	totalSteps (int theTotalSteps)
	Signal for adjusted number of steps.

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.
virtual	~QgsHttpTransaction ()
	Destructor.
QString	errorString ()
	If an operation returns 0 (e.g.
void	getAsynchronously ()
bool	getSynchronously (QByteArray &respondedContent, int redirections=0, const QByteArray *postData=0)
	Gets the response synchronously.
int	networkTimeout () const
	Returns the network timeout in msec.
QString	responseContentType ()
void	setCredentials (const QString &username, const QString &password)
	Set the credentials (username and password)
void	setNetworkTimeout (int msec)
	Sets the network timeout in milliseconds.

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

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 75 of file qgshttptransaction.cpp.

Member Function Documentation

void QgsHttpTransaction::abort ( )

slot

Aborts the current transaction.

Definition at line 565 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 508 of file qgshttptransaction.cpp.

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

slot

Definition at line 343 of file qgshttptransaction.cpp.

void QgsHttpTransaction::dataHeaderReceived ( const QHttpResponseHeader & resp )

slot

Definition at line 268 of file qgshttptransaction.cpp.

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

slot

Definition at line 318 of file qgshttptransaction.cpp.

void QgsHttpTransaction::dataReadProgress ( int theProgress )

signal

Signal for progress update.

void QgsHttpTransaction::dataReceived ( const QHttpResponseHeader & resp )

slot

Definition at line 299 of file qgshttptransaction.cpp.

void QgsHttpTransaction::dataStarted ( int id )

slot

Definition at line 261 of file qgshttptransaction.cpp.

void QgsHttpTransaction::dataStateChanged ( int state )

slot

Definition at line 437 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 503 of file qgshttptransaction.cpp.

void QgsHttpTransaction::getAsynchronously ( )

Definition at line 86 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]	respondedContent	is replaced with the new content.
[in]	redirections	is used to measure how many http redirections we've been through. Clients typically don't need to set this.
	postData	data 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 93 of file qgshttptransaction.cpp.

void QgsHttpTransaction::networkTimedOut ( )

slot

Definition at line 490 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 255 of file qgshttptransaction.cpp.

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

Set the credentials (username and password)

Definition at line 81 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 392 of file qgshttptransaction.cpp.

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

/tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgshttptransaction.h
/tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgshttptransaction.cpp

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation