QgsNetworkAccessManager Class Reference

network access manager for QGIS More...

#include <qgsnetworkaccessmanager.h>

Inheritance diagram for QgsNetworkAccessManager:

Signals
void	requestAboutToBeCreated (QNetworkAccessManager::Operation, const QNetworkRequest &, QIODevice *)
void	requestCreated (QNetworkReply *)
void	requestTimedOut (QNetworkReply *)

Public Member Functions
	QgsNetworkAccessManager (QObject *parent=nullptr)
QStringList	excludeList () const
	retrieve exclude list (urls shouldn't use the fallback proxy) More...
const QNetworkProxy &	fallbackProxy () const
	retrieve fall back proxy (for urls that no factory returned proxies for) More...
void	insertProxyFactory (QNetworkProxyFactory *factory)
	insert a factory into the proxy factories list More...
const QList< QNetworkProxyFactory * >	proxyFactories () const
	retrieve proxy factory list More...
void	removeProxyFactory (QNetworkProxyFactory *factory)
	remove a factory from the proxy factories list More...
void	setFallbackProxyAndExcludes (const QNetworkProxy &proxy, const QStringList &excludes)
	set fallback proxy and URL that shouldn't use it. More...
void	setupDefaultProxyAndCache ()
	Setup the NAM according to the user's settings. More...
bool	useSystemProxy () const
	return whether the system proxy should be used More...

Static Public Member Functions
static QNetworkRequest::CacheLoadControl	cacheLoadControlFromName (const QString &name)
	Get QNetworkRequest::CacheLoadControl from name. More...
static QString	cacheLoadControlName (QNetworkRequest::CacheLoadControl control)
	Get name for QNetworkRequest::CacheLoadControl. More...
static QgsNetworkAccessManager *	instance ()
	returns a pointer to the single instance More...

Protected Member Functions
QNetworkReply *	createRequest (QNetworkAccessManager::Operation op, const QNetworkRequest &req, QIODevice *outgoingData=nullptr) override

Detailed Description

network access manager for QGIS

Since

1.5

This class implements the QGIS network access manager. It's a singleton that can be used across QGIS.

Plugins can insert proxy factories and thereby redirect requests to individual proxies.

If no proxy factories are there or none returns a proxy for an URL a fallback proxy can be set. There's also a exclude list that defines URLs that the fallback proxy should not be used for, then no proxy will be used.

Definition at line 47 of file qgsnetworkaccessmanager.h.

Constructor & Destructor Documentation

QgsNetworkAccessManager()

QgsNetworkAccessManager::QgsNetworkAccessManager

(

QObject *

parent = nullptr

)

Definition at line 119 of file qgsnetworkaccessmanager.cpp.

Member Function Documentation

cacheLoadControlFromName()

QNetworkRequest::CacheLoadControl QgsNetworkAccessManager::cacheLoadControlFromName ( const QString &  name )

static

Get QNetworkRequest::CacheLoadControl from name.

Definition at line 263 of file qgsnetworkaccessmanager.cpp.

cacheLoadControlName()

QString QgsNetworkAccessManager::cacheLoadControlName ( QNetworkRequest::CacheLoadControl  control )

static

Get name for QNetworkRequest::CacheLoadControl.

Definition at line 245 of file qgsnetworkaccessmanager.cpp.

createRequest()

QNetworkReply * QgsNetworkAccessManager::createRequest ( QNetworkAccessManager::Operation  op, const QNetworkRequest &  req, QIODevice *  outgoingData = nullptr  )

overrideprotected

Definition at line 169 of file qgsnetworkaccessmanager.cpp.

excludeList()

QStringList QgsNetworkAccessManager::excludeList

(

)

const

retrieve exclude list (urls shouldn't use the fallback proxy)

Definition at line 140 of file qgsnetworkaccessmanager.cpp.

fallbackProxy()

const QNetworkProxy & QgsNetworkAccessManager::fallbackProxy

(

)

const

retrieve fall back proxy (for urls that no factory returned proxies for)

Definition at line 145 of file qgsnetworkaccessmanager.cpp.

insertProxyFactory()

void QgsNetworkAccessManager::insertProxyFactory

(

QNetworkProxyFactory *

factory

)

insert a factory into the proxy factories list

Definition at line 125 of file qgsnetworkaccessmanager.cpp.

instance()

QgsNetworkAccessManager * QgsNetworkAccessManager::instance ( )

static

returns a pointer to the single instance

Definition at line 105 of file qgsnetworkaccessmanager.cpp.

proxyFactories()

const QList< QNetworkProxyFactory * > QgsNetworkAccessManager::proxyFactories

(

)

const

retrieve proxy factory list

Definition at line 135 of file qgsnetworkaccessmanager.cpp.

removeProxyFactory()

void QgsNetworkAccessManager::removeProxyFactory

(

QNetworkProxyFactory *

factory

)

remove a factory from the proxy factories list

Definition at line 130 of file qgsnetworkaccessmanager.cpp.

requestAboutToBeCreated

void QgsNetworkAccessManager::requestAboutToBeCreated ( QNetworkAccessManager::Operation  , const QNetworkRequest &  , QIODevice *    )

signal

requestCreated

void QgsNetworkAccessManager::requestCreated ( QNetworkReply *  )

signal

requestTimedOut

void QgsNetworkAccessManager::requestTimedOut ( QNetworkReply *  )

signal

setFallbackProxyAndExcludes()

void QgsNetworkAccessManager::setFallbackProxyAndExcludes	(	const QNetworkProxy &	proxy,
		const QStringList &	excludes
	)

set fallback proxy and URL that shouldn't use it.

Definition at line 150 of file qgsnetworkaccessmanager.cpp.

setupDefaultProxyAndCache()

void QgsNetworkAccessManager::setupDefaultProxyAndCache

(

)

Setup the NAM according to the user's settings.

Definition at line 284 of file qgsnetworkaccessmanager.cpp.

useSystemProxy()

bool QgsNetworkAccessManager::useSystemProxy ( ) const

inline

return whether the system proxy should be used

Definition at line 86 of file qgsnetworkaccessmanager.h.

---

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

• /tmp/buildd/qgis-3.0.2+14stretch/src/core/qgsnetworkaccessmanager.h
• /tmp/buildd/qgis-3.0.2+14stretch/src/core/qgsnetworkaccessmanager.cpp