Cache for server configuration. More...

#include <qgsconfigcache.h>

Inheritance diagram for QgsConfigCache:

Public Slots
void	removeChangedEntries ()
	Remove all changed cache entries.

void	removeChangedEntry (const QString &path)
	Remove cache entry.

Signals
void	projectRemovedFromCache (const QString &path)
	Emitted whenever a project is removed from the cache.

Public Member Functions
	QgsConfigCache (QgsAbstractCacheStrategy *strategy)
	Initialize with a strategy implementation.

	QgsConfigCache (QgsServerSettings *settings)
	Initialize from settings.

const QgsProject *	project (const QString &path, const QgsServerSettings *settings=nullptr)
	If the project is not cached yet, then the project is read from the path.

QList< QgsProject * >	projects () const
	Returns projects currently in cache.

void	removeEntry (const QString &path)
	Removes an entry from cache.

QString	strategyName () const
	Returns the name of the current strategy.

Static Public Member Functions
static void	initialize (QgsServerSettings *settings)
	Initialize from settings.

static QgsConfigCache *	instance ()
	Returns the current instance.

Detailed Description

Cache for server configuration.

Definition at line 75 of file qgsconfigcache.h.

Constructor & Destructor Documentation

◆ QgsConfigCache() [1/2]

QgsConfigCache::QgsConfigCache ( QgsServerSettings * settings )

Initialize from settings.

Definition at line 85 of file qgsconfigcache.cpp.

◆ QgsConfigCache() [2/2]

QgsConfigCache::QgsConfigCache ( QgsAbstractCacheStrategy * strategy )

Initialize with a strategy implementation.

Definition at line 90 of file qgsconfigcache.cpp.

Member Function Documentation

◆ initialize()

void QgsConfigCache::initialize ( QgsServerSettings * settings )

static

Initialize from settings.

This method must be called prior any call to QgsConfigCache::instance

Definition at line 61 of file qgsconfigcache.cpp.

◆ instance()

QgsConfigCache * QgsConfigCache::instance ( )

static

Returns the current instance.

Definition at line 75 of file qgsconfigcache.cpp.

◆ project()

const QgsProject * QgsConfigCache::project	(	const QString &	path,
		const 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

Definition at line 101 of file qgsconfigcache.cpp.

◆ projectRemovedFromCache

void QgsConfigCache::projectRemovedFromCache ( const QString & path )

signal

Emitted whenever a project is removed from the cache.

Since: QGIS 3.38

◆ projects()

QList< QgsProject * > QgsConfigCache::projects ( ) const

Returns projects currently in cache.

Since: QGIS 3.30

Definition at line 192 of file qgsconfigcache.cpp.

◆ removeChangedEntries

void QgsConfigCache::removeChangedEntries ( )

slot

Remove all changed cache entries.

Definition at line 270 of file qgsconfigcache.cpp.

◆ removeChangedEntry

void QgsConfigCache::removeChangedEntry ( const QString & path )

slot

Remove cache entry.

Definition at line 264 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 250 of file qgsconfigcache.cpp.

◆ strategyName()

QString QgsConfigCache::strategyName ( ) const

inline

Returns the name of the current strategy.

Since: QGIS 3.26

Definition at line 114 of file qgsconfigcache.h.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/server/qgsconfigcache.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/server/qgsconfigcache.cpp

Public Slots

Signals

Public Member Functions

Static Public Member Functions