Defines cache interface for QGIS Server plugins. More...

#include <qgsservercachefilter.h>

Public Member Functions
	QgsServerCacheFilter (const QgsServerInterface *serverInterface)
	Constructor QgsServerInterface passed to plugins constructors and must be passed to QgsServerCacheFilter instances.

virtual	~QgsServerCacheFilter ()=default

virtual bool	deleteCachedDocument (const QgsProject *project, const QgsServerRequest &request, const QString &key) const
	Deletes the cached document.

virtual bool	deleteCachedDocuments (const QgsProject *project) const
	Deletes all cached documents for a QGIS project.

virtual bool	deleteCachedImage (const QgsProject *project, const QgsServerRequest &request, const QString &key) const
	Deletes the cached image.

virtual bool	deleteCachedImages (const QgsProject *project) const
	Deletes all cached images for a QGIS project.

virtual QByteArray	getCachedDocument (const QgsProject *project, const QgsServerRequest &request, const QString &key) const
	Returns cached document (or 0 if document not in cache) like capabilities.

virtual QByteArray	getCachedImage (const QgsProject *project, const QgsServerRequest &request, const QString &key) const
	Returns cached image (or 0 if document not in cache) like tiles.

virtual bool	setCachedDocument (const QDomDocument doc, const QgsProject project, const QgsServerRequest &request, const QString &key) const
	Updates or inserts the document in cache like capabilities.

virtual bool	setCachedImage (const QByteArray img, const QgsProject project, const QgsServerRequest &request, const QString &key) const
	Updates or inserts the image in cache like tiles.

Detailed Description

Defines cache interface for QGIS Server plugins.

Since: QGIS 3.4

Definition at line 42 of file qgsservercachefilter.h.

Constructor & Destructor Documentation

◆ QgsServerCacheFilter()

QgsServerCacheFilter::QgsServerCacheFilter ( const QgsServerInterface * serverInterface )

Constructor QgsServerInterface passed to plugins constructors and must be passed to QgsServerCacheFilter instances.

Definition at line 24 of file qgsservercachefilter.cpp.

◆ ~QgsServerCacheFilter()

virtual QgsServerCacheFilter::~QgsServerCacheFilter ( )

virtualdefault

Member Function Documentation

◆ deleteCachedDocument()

bool QgsServerCacheFilter::deleteCachedDocument	(	const QgsProject *	project,
		const QgsServerRequest &	request,
		const QString &	key
	)		const

virtual

Deletes the cached document.

Parameters

project	the project used to generate the document to provide path
request	the request used to generate the document to provider parameters or data
key	the key provided by the access control to identify different documents for the same request

Returns: true if the document has been deleted

Definition at line 46 of file qgsservercachefilter.cpp.

◆ deleteCachedDocuments()

bool QgsServerCacheFilter::deleteCachedDocuments ( const QgsProject * project ) const

virtual

Deletes all cached documents for a QGIS project.

Parameters

project the project used to generate the documents to provide path

Returns: true if the documents have been deleted

Definition at line 54 of file qgsservercachefilter.cpp.

◆ deleteCachedImage()

bool QgsServerCacheFilter::deleteCachedImage	(	const QgsProject *	project,
		const QgsServerRequest &	request,
		const QString &	key
	)		const

virtual

Deletes the cached image.

Parameters

project	the project used to generate the image to provide path
request	the request used to generate the image to provider parameters or data
key	the key provided by the access control to identify different images for the same request

Returns: true if the image has been deleted

Definition at line 77 of file qgsservercachefilter.cpp.

◆ deleteCachedImages()

bool QgsServerCacheFilter::deleteCachedImages ( const QgsProject * project ) const

virtual

Deletes all cached images for a QGIS project.

Parameters

project the project used to generate the images to provide path

Returns: true if the images have been deleted

Definition at line 85 of file qgsservercachefilter.cpp.

◆ getCachedDocument()

QByteArray QgsServerCacheFilter::getCachedDocument	(	const QgsProject *	project,
		const QgsServerRequest &	request,
		const QString &	key
	)		const

virtual

Returns cached document (or 0 if document not in cache) like capabilities.

Parameters

project	the project used to generate the document to provide path
request	the request used to generate the document to provider parameters or data
key	the key provided by the access control to identify different documents for the same request

Returns: QByteArray of the cached document or an empty one if no corresponding document found

Definition at line 29 of file qgsservercachefilter.cpp.

◆ getCachedImage()

QByteArray QgsServerCacheFilter::getCachedImage	(	const QgsProject *	project,
		const QgsServerRequest &	request,
		const QString &	key
	)		const

virtual

Returns cached image (or 0 if document not in cache) like tiles.

Parameters

project	the project used to generate the image to provide path
request	the request used to generate the image to provider parameters or data
key	the key provided by the access control to identify different images for the same request

Returns: QByteArray of the cached image or an empty one if no corresponding image found

Definition at line 60 of file qgsservercachefilter.cpp.

◆ setCachedDocument()

bool QgsServerCacheFilter::setCachedDocument	(	const QDomDocument *	doc,
		const QgsProject *	project,
		const QgsServerRequest &	request,
		const QString &	key
	)		const

virtual

Updates or inserts the document in cache like capabilities.

Parameters

doc	the document to cache
project	the project used to generate the document to provide path
request	the request used to generate the document to provider parameters or data
key	the key provided by the access control to identify different documents for the same request

Returns: true if the document has been cached

Definition at line 37 of file qgsservercachefilter.cpp.

◆ setCachedImage()

bool QgsServerCacheFilter::setCachedImage	(	const QByteArray *	img,
		const QgsProject *	project,
		const QgsServerRequest &	request,
		const QString &	key
	)		const

virtual

Updates or inserts the image in cache like tiles.

Parameters

img	the document to cache
project	the project used to generate the image to provide path
request	the request used to generate the image to provider parameters or data
key	the key provided by the access control to identify different images for the same request

Returns: true if the image has been cached

Definition at line 68 of file qgsservercachefilter.cpp.

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

/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/server/qgsservercachefilter.h
/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/server/qgsservercachefilter.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsServerCacheFilter()

◆ ~QgsServerCacheFilter()

Member Function Documentation

◆ deleteCachedDocument()

◆ deleteCachedDocuments()

◆ deleteCachedImage()

◆ deleteCachedImages()

◆ getCachedDocument()

◆ getCachedImage()

◆ setCachedDocument()

◆ setCachedImage()