novadaq::EnvVarCache Class Reference

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-23/NovaDAQUtilities/cxx/include/EnvVarCache.h"

Inheritance diagram for novadaq::EnvVarCache:

Public Member Functions
std::string	getEnvVar (std::string name)
int	getEnvVarAsLong (std::string name, long defaultValue)
double	getEnvVarAsDouble (std::string name, double defaultValue)
void	flush ()

Static Public Member Functions
static EnvVarCache &	getInstance ()

Protected Member Functions
std::string	_doGetEnvVar (std::string name)
void	_loadDataIntoCache ()
void	_clearCachedData ()
void	_reloadIfNeeded ()

Protected Attributes
CachePolicy	_policy
bool	_cacheIsEmpty
boost::mutex	_cacheMutex

Private Member Functions
	EnvVarCache (novadaq::CachePolicy policy)
	EnvVarCache (EnvVarCache const &)
void	operator= (EnvVarCache const &)

Private Attributes
std::map< std::string, std::string >	_envVarMap

Detailed Description

A singleton class that serves as a cache of environmental variable values.

Author

Kurt Biery

Version

Revision

1.1.34.1

Date

2019/09/27 00:07:20

Definition at line 18 of file EnvVarCache.h.

Constructor & Destructor Documentation

novadaq::EnvVarCache::EnvVarCache ( novadaq::CachePolicy  policy )

explicitprivate

Default constructor (private)

Definition at line 21 of file EnvVarCache.cpp.

References novadaq::CacheManager::getInstance(), and novadaq::CacheManager::registerCache().

                                                  :
    novadaq::Cache(policy) {

    // register this cache with the CacheManager so that it gets
    // flushed when the CacheManager gets a flush request
    novadaq::CacheManager::getInstance().registerCache(this);
}

novadaq::EnvVarCache::EnvVarCache ( EnvVarCache const &  )

private

Member Function Documentation

void novadaq::EnvVarCache::_clearCachedData ( )

protectedvirtual

Clears the data in the cache.

Implements novadaq::Cache.

Definition at line 137 of file EnvVarCache.cpp.

References _envVarMap.

                                   {

    // the higher-level methods that call this one take care
    // of the thread locking...

    _envVarMap.clear();
}

std::string novadaq::EnvVarCache::_doGetEnvVar ( std::string  name )

protected

Returns the value of the environmental variable with the specified name, for internal use.

Definition at line 92 of file EnvVarCache.cpp.

References _envVarMap, cet::getenv(), and string.

Referenced by getEnvVar(), getEnvVarAsDouble(), and getEnvVarAsLong().

                                                  {

    // the higher-level methods that call this one take care
    // of the thread locking...

    // look up the requested entry in the map
    std::string value;
    std::map<std::string, std::string>::iterator iter = _envVarMap.find(name);
    if (iter == _envVarMap.end()) {

        // the getenv system call is not multi-threaded, but we don't need
        // to add explicit protection here because access to the cache is
        // protected in the public methods.
        char *envPtr = getenv(name.c_str());
        if (envPtr != 0) {
            std::string tmpString(envPtr);
            value = tmpString;
        }
        else {
            value = "";
        }
        _envVarMap[name] = value;
    }
    else {
        value = iter->second;
    }

    return value;
}

void novadaq::EnvVarCache::_loadDataIntoCache ( )

protectedvirtual

Loads a new set of values into the cache.

Implements novadaq::Cache.

Definition at line 125 of file EnvVarCache.cpp.

                                     {

    // the higher-level methods that call this one take care
    // of the thread locking...

    // values are loaded on an as-needed basis, so there is nothing
    // to be done here
}

void novadaq::Cache::_reloadIfNeeded ( )

protectedinherited

Reloads the cache if needed.

Definition at line 25 of file Cache.cpp.

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

Referenced by novadaq::Cache::~Cache().

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

void novadaq::Cache::flush ( )

inherited

Flushes the cache. (Removes any saved data.)

Definition at line 8 of file Cache.cpp.

References novadaq::Cache::_cacheIsEmpty, novadaq::Cache::_cacheMutex, and novadaq::Cache::_clearCachedData().

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

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

std::string novadaq::EnvVarCache::getEnvVar

(

std::string

name

)

Returns the value of the environmental variable with the specified name. If the env var is not found, an empty string is returned.

Definition at line 33 of file EnvVarCache.cpp.

References novadaq::Cache::_cacheMutex, and _doGetEnvVar().

Referenced by dbutils::gui::BasicEditorDisplay::_confirmSave(), dbutils::daqappmgr::ConfiguredProcessList::_fetchProcessData(), dbutils::daqconfig::DLRunConfig::_fetchStreamData(), dbutils::daqconfig::BNEVBRunConfig::_fetchSystemData(), dbutils::daqconfig::DLRunConfig::_fetchSystemData(), dbutils::daqconfig::GTRunConfig::_fetchTriggerData(), dbutils::gui::ConfigDataTableModel::ConfigDataTableModel(), dbutils::daqconfig::ConfigDataTree::ConfigDataTree(), dbutils::daqconfig::NamedConfigUtils::copyGlobalConfig(), dbutils::daqconfig::NamedConfigUtils::copySubsystemConfig(), dbutils::gui::DAQConfigEditorDisplay::DAQConfigEditorDisplay(), dbutils::gui::DBParamsGroupBox::DBParamsGroupBox(), dbutils::gui::DCSConfigEditorDisplay::DCSConfigEditorDisplay(), dbutils::gui::DCSConfigEditorDisplay::generateRecipeScripts(), dbutils::daqconfig::NamedConfigUtils::getAvailableGlobalConfigs(), dbutils::daqconfig::NamedConfigUtils::getAvailableSubsystemConfigs(), dbutils::daqconfig::NamedConfigUtils::getConfigDetailAncestry(), dbutils::daqconfig::NamedConfigUtils::getConfigIdAncestry(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigDetailAncestry(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigId(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigIdAncestry(), dbutils::daqconfig::NamedConfigUtils::getNewestGlobalConfigFromGlobalId(), dbutils::daqconfig::NamedConfigUtils::getNewestGlobalConfigFromSubsystemId(), dbutils::daqconfig::NamedConfigUtils::getNewestGlobalConfigFromSubsystemName(), dbutils::daqconfig::NamedConfigUtils::getNewestInstanceOfLatestUsedDAQGlobalConfig(), dbutils::daqconfig::NamedConfigUtils::getRecentGlobalConfigs(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigId(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigIdAncestry(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigIdAncestryFromGlobalId(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigIdFromGlobalId(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigIdFromGlobalName(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigIdsFromGlobalId(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigsFromGlobalId(), dbutils::daqconfig::NamedConfigUtils::incrementUsageCount(), dbutils::daqconfig::NamedConfigUtils::markConfigDone(), dbutils::gui::BasicEditorDisplay::reactToDataChange(), dbutils::daqconfig::ConfigDataTree::saveValues(), CacheTests::testEnvVarCacheBasic(), and CacheTests::testEnvVarCacheNumbers().

                                               {

    // protect against unsynchronized access to the cache
    boost::mutex::scoped_lock lock(_cacheMutex);

    // (global reloads are not needed since we only load values as needed)
    //_reloadIfNeeded();

    return this->_doGetEnvVar(name);
}

double novadaq::EnvVarCache::getEnvVarAsDouble	(	std::string	name,
		double	defaultValue
	)

Returns the value of the environmental variable with the specified name with the value interpreted as a double-precision number.

Definition at line 70 of file EnvVarCache.cpp.

References novadaq::Cache::_cacheMutex, _doGetEnvVar(), and string.

Referenced by CacheTests::testEnvVarCacheNumbers().

                                                                         {

    // protect against unsynchronized access to the cache
    boost::mutex::scoped_lock lock(_cacheMutex);

    // (global reloads are not needed since we only load values as needed)
    //_reloadIfNeeded();

    std::string valueString = this->_doGetEnvVar(name);
    double doubleValue = defaultValue;
    try {
        doubleValue = boost::lexical_cast<double>(valueString);
    }
    catch (boost::bad_lexical_cast &excpt) {}

    return doubleValue;
}

int novadaq::EnvVarCache::getEnvVarAsLong	(	std::string	name,
		long	defaultValue
	)

Returns the value of the environmental variable with the specified name with the value interpreted as a long integer.

Definition at line 48 of file EnvVarCache.cpp.

References novadaq::Cache::_cacheMutex, _doGetEnvVar(), and string.

Referenced by CacheTests::testEnvVarCacheNumbers().

                                                                  {

    // protect against unsynchronized access to the cache
    boost::mutex::scoped_lock lock(_cacheMutex);

    // (global reloads are not needed since we only load values as needed)
    //_reloadIfNeeded();

    std::string valueString = this->_doGetEnvVar(name);
    long longValue = defaultValue;
    try {
        longValue = boost::lexical_cast<long>(valueString);
    }
    catch (boost::bad_lexical_cast &excpt) {}

    return longValue;
}

EnvVarCache & novadaq::EnvVarCache::getInstance ( )

static

Returns the single instance of the EnvVarCache.

Returns

EnvVarCache instance.

Definition at line 12 of file EnvVarCache.cpp.

Referenced by dbutils::gui::BasicEditorDisplay::_confirmSave(), dbutils::daqappmgr::ConfiguredProcessList::_fetchProcessData(), dbutils::daqconfig::DLRunConfig::_fetchStreamData(), dbutils::daqconfig::BNEVBRunConfig::_fetchSystemData(), dbutils::daqconfig::DLRunConfig::_fetchSystemData(), dbutils::daqconfig::GTRunConfig::_fetchTriggerData(), dbutils::gui::ConfigDataTableModel::ConfigDataTableModel(), dbutils::daqconfig::ConfigDataTree::ConfigDataTree(), gov::fnal::cd::rms::provider::DPSingleton::connect_participant(), dbutils::daqconfig::NamedConfigUtils::copyGlobalConfig(), dbutils::daqconfig::NamedConfigUtils::copySubsystemConfig(), dbutils::gui::DAQConfigEditorDisplay::DAQConfigEditorDisplay(), dbutils::gui::DBParamsGroupBox::DBParamsGroupBox(), dbutils::gui::DCSConfigEditorDisplay::DCSConfigEditorDisplay(), dbutils::gui::DCSConfigEditorDisplay::generateRecipeScripts(), dbutils::daqconfig::NamedConfigUtils::getAvailableGlobalConfigs(), dbutils::daqconfig::NamedConfigUtils::getAvailableSubsystemConfigs(), dbutils::daqconfig::NamedConfigUtils::getConfigDetailAncestry(), dbutils::daqconfig::NamedConfigUtils::getConfigIdAncestry(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigDetailAncestry(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigId(), dbutils::daqconfig::NamedConfigUtils::getGlobalConfigIdAncestry(), dbutils::daqconfig::NamedConfigUtils::getNewestGlobalConfigFromGlobalId(), dbutils::daqconfig::NamedConfigUtils::getNewestGlobalConfigFromSubsystemId(), dbutils::daqconfig::NamedConfigUtils::getNewestGlobalConfigFromSubsystemName(), dbutils::daqconfig::NamedConfigUtils::getNewestInstanceOfLatestUsedDAQGlobalConfig(), dbutils::daqconfig::NamedConfigUtils::getRecentGlobalConfigs(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigId(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigIdAncestry(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigIdAncestryFromGlobalId(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigIdFromGlobalId(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigIdFromGlobalName(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigIdsFromGlobalId(), dbutils::daqconfig::NamedConfigUtils::getSubsystemConfigsFromGlobalId(), dbutils::daqconfig::NamedConfigUtils::incrementUsageCount(), gov::fnal::cd::rms::provider::DDSTopicWriterClass< TT_ >::init(), gov::fnal::cd::rms::provider::DDSTopicReaderClass< TT_ >::init(), dbutils::daqconfig::NamedConfigUtils::markConfigDone(), dbutils::gui::BasicEditorDisplay::reactToDataChange(), dbutils::daqconfig::ConfigDataTree::saveValues(), CacheTests::testEnvVarCacheBasic(), CacheTests::testEnvVarCacheNumbers(), and gov::fnal::cd::rms::provider::DDSTopicWriterClass< TT_ >::waitForNetworkServices().

                                      {
    static TimedCachePolicy policy(100000);
    static EnvVarCache singletonInstance(policy);
    return singletonInstance;
}

void novadaq::EnvVarCache::operator= ( EnvVarCache const &  )

private

Member Data Documentation

bool novadaq::Cache::_cacheIsEmpty

protectedinherited

Definition at line 40 of file Cache.h.

Referenced by novadaq::Cache::_reloadIfNeeded(), and novadaq::Cache::flush().

boost::mutex novadaq::Cache::_cacheMutex

protectedinherited

Definition at line 41 of file Cache.h.

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

std::map<std::string, std::string> novadaq::EnvVarCache::_envVarMap

private

Definition at line 48 of file EnvVarCache.h.

Referenced by _clearCachedData(), and _doGetEnvVar().

CachePolicy novadaq::Cache::_policy

protectedinherited

Definition at line 39 of file Cache.h.

Referenced by novadaq::Cache::_reloadIfNeeded().

---

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

• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-23/NovaDAQUtilities/cxx/include/EnvVarCache.h
• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-23/NovaDAQUtilities/cxx/src/EnvVarCache.cpp