novadaq::Cache Class Reference

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-24/NovaDAQUtilities/cxx/include/Cache.h"

Inheritance diagram for novadaq::Cache:

Public Member Functions
void	flush ()
virtual	~Cache ()

Protected Member Functions
	Cache (CachePolicy policy)
void	_reloadIfNeeded ()
virtual void	_loadDataIntoCache ()=0
virtual void	_clearCachedData ()=0

Protected Attributes
CachePolicy	_policy
bool	_cacheIsEmpty
boost::mutex	_cacheMutex

Detailed Description

A base class to be used when implementing a cache of data. That is, a set of data that is not expected to change often, but which may need to be updated at some point (either through some automatic means or via user or application request).

Author

Kurt Biery

Version

Revision

1.1.34.1

Date

2019/09/27 00:07:20

Definition at line 19 of file Cache.h.

Constructor & Destructor Documentation

virtual novadaq::Cache::~Cache ( )

inlinevirtual

Definition at line 25 of file Cache.h.

References _clearCachedData(), _loadDataIntoCache(), _reloadIfNeeded(), and Cache().

{};

novadaq::Cache::Cache ( CachePolicy  policy )

explicitprotected

Constructor.

Parameters

policy

the CachePolicy to use for automatically expiring the cache.

Definition at line 20 of file Cache.cpp.

Referenced by ~Cache().

: _policy(policy), _cacheIsEmpty(true) {}

Member Function Documentation

virtual void novadaq::Cache::_clearCachedData ( )

protectedpure virtual

Implemented in novadaq::EnvVarCache.

Referenced by _reloadIfNeeded(), flush(), and ~Cache().

virtual void novadaq::Cache::_loadDataIntoCache ( )

protectedpure virtual

Implemented in novadaq::EnvVarCache.

Referenced by _reloadIfNeeded(), and ~Cache().

void novadaq::Cache::_reloadIfNeeded ( )

protected

Reloads the cache if needed.

Definition at line 25 of file Cache.cpp.

References _cacheIsEmpty, _clearCachedData(), _loadDataIntoCache(), _policy, novadaq::CachePolicy::cacheUpdated(), and novadaq::CachePolicy::isExpired().

Referenced by ~Cache().

                            {
    if (_cacheIsEmpty || _policy.isExpired()) {
        _clearCachedData();
        _loadDataIntoCache();
        _cacheIsEmpty = false;
        _policy.cacheUpdated();
    }
}

void novadaq::Cache::flush

(

)

Flushes the cache. (Removes any saved data.)

Definition at line 8 of file Cache.cpp.

References _cacheIsEmpty, _cacheMutex, and _clearCachedData().

Referenced by CacheTests::testEnvVarCacheBasic(), and CacheTests::testEnvVarCacheNumbers().

                  {
    boost::mutex::scoped_lock lock(_cacheMutex);
    _clearCachedData();
    _cacheIsEmpty = true;
}

Member Data Documentation

bool novadaq::Cache::_cacheIsEmpty

protected

Definition at line 40 of file Cache.h.

Referenced by _reloadIfNeeded(), and flush().

boost::mutex novadaq::Cache::_cacheMutex

protected

Definition at line 41 of file Cache.h.

Referenced by flush(), novadaq::EnvVarCache::getEnvVar(), novadaq::EnvVarCache::getEnvVarAsDouble(), and novadaq::EnvVarCache::getEnvVarAsLong().

CachePolicy novadaq::Cache::_policy

protected

Definition at line 39 of file Cache.h.

Referenced by _reloadIfNeeded().

---

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

• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-24/NovaDAQUtilities/cxx/include/Cache.h
• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-24/NovaDAQUtilities/cxx/src/Cache.cpp