A thread safe class for performing blocking (sync) network requests, with full support for QGIS proxy and authentication settings. More...

#include <qgsblockingnetworkrequest.h>

Inheritance diagram for QgsBlockingNetworkRequest:

[legend]

Public Types
enum	ErrorCode { NoError , NetworkError , TimeoutError , ServerExceptionError }
	Error codes. More...

enum class	RequestFlag : int { EmptyResponseIsValid = 1 << 0 }
	Request flags. More...

typedef QFlags< RequestFlag >	RequestFlags

Public Slots
void	abort ()
	Aborts the network request immediately.

Signals
Q_DECL_DEPRECATED void	downloadFinished ()
	Emitted once a request has finished downloading.

void	downloadProgress (qint64 bytesReceived, qint64 bytesTotal)
	Emitted when when data arrives during a request.

void	finished ()
	Emitted once a request has finished.

void	uploadProgress (qint64 bytesReceived, qint64 bytesTotal)
	Emitted when when data are sent during a request.

Public Member Functions
	QgsBlockingNetworkRequest ()
	Constructor for QgsBlockingNetworkRequest.

	~QgsBlockingNetworkRequest () override

QString	authCfg () const
	Returns the authentication config id which will be used during the request.

ErrorCode	deleteResource (QNetworkRequest &request, QgsFeedback *feedback=nullptr)
	Performs a "delete" operation on the specified request.

QString	errorMessage () const
	Returns the error message string, after a get(), post(), head() or put() request has been made.

ErrorCode	get (QNetworkRequest &request, bool forceRefresh=false, QgsFeedback *feedback=nullptr, RequestFlags requestFlags=QgsBlockingNetworkRequest::RequestFlags())
	Performs a "get" operation on the specified request.

ErrorCode	head (QNetworkRequest &request, bool forceRefresh=false, QgsFeedback *feedback=nullptr)
	Performs a "head" operation on the specified request.

ErrorCode	post (QNetworkRequest &request, const QByteArray &data, bool forceRefresh=false, QgsFeedback *feedback=nullptr)
	This is an overloaded function.

ErrorCode	post (QNetworkRequest &request, QIODevice data, bool forceRefresh=false, QgsFeedback feedback=nullptr)
	Performs a "post" operation on the specified request, using the given data.

ErrorCode	put (QNetworkRequest &request, const QByteArray &data, QgsFeedback *feedback=nullptr)
	This is an overloaded function.

ErrorCode	put (QNetworkRequest &request, QIODevice data, QgsFeedback feedback=nullptr)
	Performs a "put" operation on the specified request, using the given data.

QgsNetworkReplyContent	reply () const
	Returns the content of the network reply, after a get(), post(), head() or put() request has been made.

void	setAuthCfg (const QString &authCfg)
	Sets the authentication config id which should be used during the request.

Detailed Description

A thread safe class for performing blocking (sync) network requests, with full support for QGIS proxy and authentication settings.

This class should be used whenever a blocking network request is required. Unlike implementations which rely on QApplication::processEvents() or creation of a QEventLoop, this class is completely thread safe and can be used on either the main thread or background threads without issue.

Redirects are automatically handled by the class.

After completion of a request, the reply content should be retrieved by calling getReplyContent(). This method returns a QgsNetworkReplyContent container, which is safe and cheap to copy and pass between threads without issue.

Since: QGIS 3.6

Definition at line 46 of file qgsblockingnetworkrequest.h.

Member Typedef Documentation

◆ RequestFlags

typedef QFlags< RequestFlag > QgsBlockingNetworkRequest::RequestFlags

Definition at line 70 of file qgsblockingnetworkrequest.h.

Member Enumeration Documentation

◆ ErrorCode

enum QgsBlockingNetworkRequest::ErrorCode

Error codes.

Enumerator
NoError	No error was encountered.
NetworkError	A network error occurred.
TimeoutError	Timeout was reached before a reply was received.
ServerExceptionError	An exception was raised by the server.

Definition at line 52 of file qgsblockingnetworkrequest.h.

◆ RequestFlag

enum class QgsBlockingNetworkRequest::RequestFlag : int

strong

Request flags.

Since: QGIS 3.40

Enumerator
EmptyResponseIsValid	Do not generate an error if getting an empty response (e.g. HTTP 204)

Definition at line 65 of file qgsblockingnetworkrequest.h.

Constructor & Destructor Documentation

◆ QgsBlockingNetworkRequest()

QgsBlockingNetworkRequest::QgsBlockingNetworkRequest ( )

explicit

Constructor for QgsBlockingNetworkRequest.

Definition at line 34 of file qgsblockingnetworkrequest.cpp.

◆ ~QgsBlockingNetworkRequest()

QgsBlockingNetworkRequest::~QgsBlockingNetworkRequest ( )

override

Definition at line 39 of file qgsblockingnetworkrequest.cpp.

Member Function Documentation

◆ abort

void QgsBlockingNetworkRequest::abort ( )

slot

Aborts the network request immediately.

Definition at line 285 of file qgsblockingnetworkrequest.cpp.

◆ authCfg()

QString QgsBlockingNetworkRequest::authCfg ( ) const

Returns the authentication config id which will be used during the request.

See also: setAuthCfg()

Definition at line 50 of file qgsblockingnetworkrequest.cpp.

◆ deleteResource()

QgsBlockingNetworkRequest::ErrorCode QgsBlockingNetworkRequest::deleteResource	(	QNetworkRequest &	request,
		QgsFeedback *	feedback = `nullptr`
	)

Performs a "delete" operation on the specified request.

If an authCfg() has been set, then any authentication configuration required will automatically be applied to request. There is no need to manually apply the authentication to the request prior to calling this method.

The optional feedback argument can be used to abort ongoing requests.

The method will return NoError if the get operation was successful. The contents of the reply can be retrieved by calling reply().

If an error was encountered then a specific ErrorCode will be returned, and a detailed error message can be retrieved by calling errorMessage().

Since: QGIS 3.18

Definition at line 98 of file qgsblockingnetworkrequest.cpp.

◆ downloadFinished

Q_DECL_DEPRECATED void QgsBlockingNetworkRequest::downloadFinished ( )

signal

Emitted once a request has finished downloading.

Deprecated:: QGIS 3.40. Use the finished() signal instead.

◆ downloadProgress

void QgsBlockingNetworkRequest::downloadProgress	(	qint64	bytesReceived,
		qint64	bytesTotal
	)

signal

Emitted when when data arrives during a request.

◆ errorMessage()

QString QgsBlockingNetworkRequest::errorMessage ( ) const

inline

Returns the error message string, after a get(), post(), head() or put() request has been made.

Definition at line 203 of file qgsblockingnetworkrequest.h.

◆ finished

void QgsBlockingNetworkRequest::finished ( )

signal

Emitted once a request has finished.

◆ get()

QgsBlockingNetworkRequest::ErrorCode QgsBlockingNetworkRequest::get	(	QNetworkRequest &	request,
		bool	forceRefresh = `false`,
		QgsFeedback *	feedback = `nullptr`,
		RequestFlags	requestFlags = `QgsBlockingNetworkRequest::RequestFlags()`
	)

Performs a "get" operation on the specified request.

If forceRefresh is false then previously cached replies may be used for the request. If it is set to true then a new query is always performed.

If an authCfg() has been set, then any authentication configuration required will automatically be applied to request. There is no need to manually apply the authentication to the request prior to calling this method.

The optional feedback argument can be used to abort ongoing requests.

The optional requestFlags argument can be used to modify the behavior (added in QGIS 3.40).

The method will return NoError if the get operation was successful. The contents of the reply can be retrieved by calling reply().

If an error was encountered then a specific ErrorCode will be returned, and a detailed error message can be retrieved by calling errorMessage().

See also: post()

Definition at line 60 of file qgsblockingnetworkrequest.cpp.

◆ head()

QgsBlockingNetworkRequest::ErrorCode QgsBlockingNetworkRequest::head	(	QNetworkRequest &	request,
		bool	forceRefresh = `false`,
		QgsFeedback *	feedback = `nullptr`
	)

Performs a "head" operation on the specified request.

If forceRefresh is false then previously cached replies may be used for the request. If it is set to true then a new query is always performed.

If an authCfg() has been set, then any authentication configuration required will automatically be applied to request. There is no need to manually apply the authentication to the request prior to calling this method.

The optional feedback argument can be used to abort ongoing requests.

The method will return NoError if the get operation was successful. The contents of the reply can be retrieved by calling reply().

If an error was encountered then a specific ErrorCode will be returned, and a detailed error message can be retrieved by calling errorMessage().

Since: QGIS 3.18

Definition at line 79 of file qgsblockingnetworkrequest.cpp.

◆ post() [1/2]

QgsBlockingNetworkRequest::ErrorCode QgsBlockingNetworkRequest::post	(	QNetworkRequest &	request,
		const QByteArray &	data,
		bool	forceRefresh = `false`,
		QgsFeedback *	feedback = `nullptr`
	)

This is an overloaded function.

Performs a "post" operation on the specified request, using the given data.

Definition at line 65 of file qgsblockingnetworkrequest.cpp.

◆ post() [2/2]

QgsBlockingNetworkRequest::ErrorCode QgsBlockingNetworkRequest::post	(	QNetworkRequest &	request,
		QIODevice *	data,
		bool	forceRefresh = `false`,
		QgsFeedback *	feedback = `nullptr`
	)

Performs a "post" operation on the specified request, using the given data.

If forceRefresh is false then previously cached replies may be used for the request. If it is set to true then a new query is always performed.

If an authCfg() has been set, then any authentication configuration required will automatically be applied to request. There is no need to manually apply the authentication to the request prior to calling this method.

The optional feedback argument can be used to abort ongoing requests.

The method will return NoError if the get operation was successful. The contents of the reply can be retrieved by calling reply().

If an error was encountered then a specific ErrorCode will be returned, and a detailed error message can be retrieved by calling errorMessage().

See also: get()

Since: QGIS 3.22

Definition at line 73 of file qgsblockingnetworkrequest.cpp.

◆ put() [1/2]

QgsBlockingNetworkRequest::ErrorCode QgsBlockingNetworkRequest::put	(	QNetworkRequest &	request,
		const QByteArray &	data,
		QgsFeedback *	feedback = `nullptr`
	)

This is an overloaded function.

Performs a "put" operation on the specified request, using the given data.

Since: QGIS 3.18

Definition at line 84 of file qgsblockingnetworkrequest.cpp.

◆ put() [2/2]

QgsBlockingNetworkRequest::ErrorCode QgsBlockingNetworkRequest::put	(	QNetworkRequest &	request,
		QIODevice *	data,
		QgsFeedback *	feedback = `nullptr`
	)

Performs a "put" operation on the specified request, using the given data.

If an authCfg() has been set, then any authentication configuration required will automatically be applied to request. There is no need to manually apply the authentication to the request prior to calling this method.

The optional feedback argument can be used to abort ongoing requests.

The method will return NoError if the get operation was successful. The contents of the reply can be retrieved by calling reply().

If an error was encountered then a specific ErrorCode will be returned, and a detailed error message can be retrieved by calling errorMessage().

Since: QGIS 3.22

Definition at line 92 of file qgsblockingnetworkrequest.cpp.

◆ reply()

QgsNetworkReplyContent QgsBlockingNetworkRequest::reply ( ) const

inline

Returns the content of the network reply, after a get(), post(), head() or put() request has been made.

Definition at line 208 of file qgsblockingnetworkrequest.h.

◆ setAuthCfg()

void QgsBlockingNetworkRequest::setAuthCfg ( const QString & authCfg )

Sets the authentication config id which should be used during the request.

See also: authCfg()

Definition at line 55 of file qgsblockingnetworkrequest.cpp.

◆ uploadProgress

void QgsBlockingNetworkRequest::uploadProgress	(	qint64	bytesReceived,
		qint64	bytesTotal
	)

signal

Emitted when when data are sent during a request.

Since: QGIS 3.22

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/network/qgsblockingnetworkrequest.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/network/qgsblockingnetworkrequest.cpp

Public Types

Public Slots

Signals

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ RequestFlags

Member Enumeration Documentation

◆ ErrorCode

◆ RequestFlag

Constructor & Destructor Documentation

◆ QgsBlockingNetworkRequest()

◆ ~QgsBlockingNetworkRequest()

Member Function Documentation

◆ abort

◆ authCfg()

◆ deleteResource()

◆ downloadFinished

◆ downloadProgress

◆ errorMessage()

◆ finished

◆ get()

◆ head()

◆ post() [1/2]

◆ post() [2/2]

◆ put() [1/2]

◆ put() [2/2]

◆ reply()

◆ setAuthCfg()

◆ uploadProgress