QGIS API Documentation 3.27.0-Master (1d7a28cfd2)
Public Member Functions | List of all members
QgsPeriodicCacheStrategy Class Reference

Periodic system cache strategy for server configuration. More...

#include <qgsconfigcache.h>

Inheritance diagram for QgsPeriodicCacheStrategy:
Inheritance graph
[legend]

Public Member Functions

 QgsPeriodicCacheStrategy (int interval=3000)
 Creates a new periodic strategy. More...
 
void attach (QgsConfigCache *owner) override
 Attaches cache to this strategy. More...
 
int checkInterval () const
 Returns the invalidation check interval. More...
 
void entryInserted (const QString &path) override
 Called when an entry is inserted. More...
 
void entryRemoved (const QString &path) override
 Called when an entry is removed from cache. More...
 
QString name () const override
 The name of the strategy. More...
 
void setCheckInterval (int msec)
 Sets the invalidation check interval for PeriodicStrategy. More...
 
- Public Member Functions inherited from QgsAbstractCacheStrategy
virtual ~QgsAbstractCacheStrategy ()=default
 
virtual void attach (QgsConfigCache *cache)=0
 Attache cache to this strategy. More...
 
virtual void entryInserted (const QString &path)=0
 Called when an entry is removed from cache. More...
 
virtual void entryRemoved (const QString &path)=0
 Called when an entry is removed from cache. More...
 
virtual QString name () const =0
 The name of the strategy. More...
 

Detailed Description

Periodic system cache strategy for server configuration.

Since
QGIS 3.26

Definition at line 197 of file qgsconfigcache.h.

Constructor & Destructor Documentation

◆ QgsPeriodicCacheStrategy()

QgsPeriodicCacheStrategy::QgsPeriodicCacheStrategy ( int  interval = 3000)

Creates a new periodic strategy.

Parameters
intervalThe invalidation check interval in milliseconds

Definition at line 289 of file qgsconfigcache.cpp.

Member Function Documentation

◆ attach()

void QgsPeriodicCacheStrategy::attach ( QgsConfigCache owner)
overridevirtual

Attaches cache to this strategy.

Implements QgsAbstractCacheStrategy.

Definition at line 294 of file qgsconfigcache.cpp.

◆ checkInterval()

int QgsPeriodicCacheStrategy::checkInterval ( ) const
inline

Returns the invalidation check interval.

Definition at line 219 of file qgsconfigcache.h.

◆ entryInserted()

void QgsPeriodicCacheStrategy::entryInserted ( const QString &  path)
overridevirtual

Called when an entry is inserted.

Parameters
pathThe path of the project

Implements QgsAbstractCacheStrategy.

Definition at line 307 of file qgsconfigcache.cpp.

◆ entryRemoved()

void QgsPeriodicCacheStrategy::entryRemoved ( const QString &  path)
overridevirtual

Called when an entry is removed from cache.

Parameters
pathThe path of the project

Implements QgsAbstractCacheStrategy.

Definition at line 301 of file qgsconfigcache.cpp.

◆ name()

QString QgsPeriodicCacheStrategy::name ( ) const
inlineoverridevirtual

The name of the strategy.

Implements QgsAbstractCacheStrategy.

Definition at line 208 of file qgsconfigcache.h.

◆ setCheckInterval()

void QgsPeriodicCacheStrategy::setCheckInterval ( int  msec)

Sets the invalidation check interval for PeriodicStrategy.

If msec is set to a positive value then the cache will check for invalidation every msec milliseconds

Definition at line 316 of file qgsconfigcache.cpp.


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