QgsConfigCache Class Reference

Cache for server configuration. More...

#include <qgsconfigcache.h>

Inheritance diagram for QgsConfigCache:

Public Member Functions
const QgsProject *	project (const QString &path, QgsServerSettings *settings=nullptr)
	If the project is not cached yet, then the project is read from the path. More...
void	removeEntry (const QString &path)
	Removes an entry from cache. More...

Static Public Member Functions
static QgsConfigCache *	instance ()
	Returns the current instance. More...

Detailed Description

Cache for server configuration.

Since

QGIS 2.8

Definition at line 38 of file qgsconfigcache.h.

Member Function Documentation

instance()

QgsConfigCache * QgsConfigCache::instance ( )

static

Returns the current instance.

Definition at line 26 of file qgsconfigcache.cpp.

project()

const QgsProject * QgsConfigCache::project	(	const QString &	path,
		QgsServerSettings *	settings = nullptr
	)

If the project is not cached yet, then the project is read from the path.

If the project is not available, then nullptr is returned. If the project contains any bad layer it is considered unavailable unless the server configuration variable QGIS_SERVER_IGNORE_BAD_LAYERS passed in the optional settings argument is set to true (the default value is false).

Parameters

path	the filename of the QGIS project
settings	QGIS server settings

Returns

the project or nullptr if an error happened

Since

QGIS 3.0

Definition at line 42 of file qgsconfigcache.cpp.

removeEntry()

void QgsConfigCache::removeEntry

(

const QString &

path

)

Removes an entry from cache.

Parameters

path	The path of the project

Definition at line 169 of file qgsconfigcache.cpp.

---

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

• /build/qgis-3.16.0+99unstable/src/server/qgsconfigcache.h
• /build/qgis-3.16.0+99unstable/src/server/qgsconfigcache.cpp