dunedaq::conffwk::ConfigurationImpl Class Reference

Provides pure virtual interface used by the Configuration class. More...

#include <ConfigurationImpl.hpp>

Inheritance diagram for dunedaq::conffwk::ConfigurationImpl:

Collaboration diagram for dunedaq::conffwk::ConfigurationImpl:

Public Types
typedef void(*)	notify(std::vector< ConfigurationChange * > &changes, Configuration *)
	Callback to notify database changes.
typedef void(*)	pre_notify(Configuration *)
	Callback to pre-notify database changes.

Public Member Functions
	ConfigurationImpl () noexcept
	The constructor.
virtual	~ConfigurationImpl ()
	Virtual destructor.
virtual void	open_db (const std::string &db_name)=0
	Open database implementation in accordance with given name.
virtual void	close_db ()=0
	Close database implementation.
virtual bool	loaded () const noexcept=0
	Check if a database is loaded.
virtual void	create (const std::string &db_name, const std::list< std::string > &includes)=0
	Create database.
virtual bool	is_writable (const std::string &db_name)=0
	Return write access status.
virtual void	add_include (const std::string &db_name, const std::string &include)=0
	Add include file.
virtual void	remove_include (const std::string &db_name, const std::string &include)=0
	Remove include file.
virtual void	get_includes (const std::string &db_name, std::list< std::string > &includes) const =0
	Get included files.
virtual void	get_updated_dbs (std::list< std::string > &dbs) const =0
	Get uncommitted files.
virtual void	set_commit_credentials (const std::string &user, const std::string &password)=0
	Set commit credentials.
virtual void	commit (const std::string &log_message)=0
	Commit database changes.
virtual void	abort ()=0
	Abort database changes.
virtual void	prefetch_all_data ()=0
	Prefetch all data into client cache.
virtual std::vector< dunedaq::conffwk::Version >	get_changes ()=0
	Get newly available versions.
virtual std::vector< dunedaq::conffwk::Version >	get_versions (const std::string &since, const std::string &until, dunedaq::conffwk::Version::QueryType type, bool skip_irrelevant)=0
	Get archived versions.
virtual void	get (const std::string &class_name, const std::string &id, ConfigObject &object, unsigned long rlevel, const std::vector< std::string > *rclasses)=0
	Get object of class by id.
virtual void	get (const std::string &class_name, std::vector< ConfigObject > &objects, const std::string &query, unsigned long rlevel, const std::vector< std::string > *rclasses)=0
	Get objects of class according to query.
virtual void	get (const ConfigObject &obj_from, const std::string &query, std::vector< ConfigObject > &objects, unsigned long rlevel, const std::vector< std::string > *rclasses)=0
	Get objects according to path.
virtual bool	test_object (const std::string &class_name, const std::string &id, unsigned long rlevel, const std::vector< std::string > *rclasses)=0
	Test object existence (used by Python binding).
virtual void	create (const std::string &at, const std::string &class_name, const std::string &id, ConfigObject &object)=0
	Create object of class by id at given file.
virtual void	create (const ConfigObject &at, const std::string &class_name, const std::string &id, ConfigObject &object)=0
	Create object of class by id at file identified by object 'at'.
virtual void	destroy (ConfigObject &object)=0
	Destroy object of class by id.
virtual dunedaq::conffwk::class_t *	get (const std::string &class_name, bool direct_only)=0
	Get description of class in accordance with parameters.
virtual void	get_superclasses (conffwk::fmap< conffwk::fset > &schema)=0
	Get inheritance hierarchy.
virtual void	subscribe (const std::set< std::string > &class_names, const std::map< std::string, std::set< std::string > > &objs, notify cb, pre_notify pre_cb)=0
	Subscribe on database changes.
virtual void	unsubscribe ()=0
	Remove subscription on database changes.
virtual void	print_profiling_info () noexcept=0
	Print implementation specific profiling information.
void	print_cache_info () noexcept
	Print profiling information about objects in cache.
void	set (Configuration *db) noexcept
	set configuration object
void	rename_impl_object (const std::string *class_name, const std::string &old_id, const std::string &new_id) noexcept
	rename object in cache

Protected Member Functions
ConfigObjectImpl *	get_impl_object (const std::string &class_name, const std::string &id) const noexcept
	get object from cache
void	put_impl_object (const std::string &class_name, const std::string &id, ConfigObjectImpl *obj) noexcept
	put object to cache
template<class T, class OBJ>
T *	insert_object (OBJ &obj, const std::string &id, const std::string &class_name) noexcept
	insert new object (update cache or create-and-insert)
void	clean () noexcept
	clean cache (e.g. to be used by destructor)
std::mutex &	get_conf_impl_mutex () const
	Is required by reload methods.

Protected Attributes
Configuration *	m_conf
	Configuration pointer is needed for notification on changes, e.g. in case of subscription or an object deletion.

Private Attributes
conffwk::pmap< conffwk::map< ConfigObjectImpl * > * >	m_impl_objects
	cache of implementation objects (class-name::->object_id->implementation)
std::vector< ConfigObjectImpl * >	m_tangled_objects
unsigned long	p_number_of_cache_hits
unsigned long	p_number_of_object_read

Friends
class	ConfigObject
class	ConfigObjectImpl
class	Configuration

Detailed Description

Provides pure virtual interface used by the Configuration class.

The class has several pure virtual methods to manipulate databases, access database information, subscribe and receive notification on data changes. Any database implementation inherits from this class and implements it's methods.

The methods may throw dunedaq::conffwk::Exception exception (like Generic, NotFound) in case of an error unless noexcept is explicitly used in their specification.

Definition at line 48 of file ConfigurationImpl.hpp.

Member Typedef Documentation

notify

typedef void(*) dunedaq::conffwk::ConfigurationImpl::notify(std::vector< ConfigurationChange * > &changes, Configuration *)

Callback to notify database changes.

Definition at line 201 of file ConfigurationImpl.hpp.

pre_notify

typedef void(*) dunedaq::conffwk::ConfigurationImpl::pre_notify(Configuration *)

Callback to pre-notify database changes.

Definition at line 205 of file ConfigurationImpl.hpp.

Constructor & Destructor Documentation

ConfigurationImpl()

dunedaq::conffwk::ConfigurationImpl::ConfigurationImpl ( )

noexcept

The constructor.

Definition at line 285 of file ConfigurationImpl.cpp.

  : p_number_of_cache_hits(0)
  , p_number_of_object_read(0)
  , m_conf(0)
{
}

~ConfigurationImpl()

dunedaq::conffwk::ConfigurationImpl::~ConfigurationImpl ( )

virtual

Virtual destructor.

Definition at line 292 of file ConfigurationImpl.cpp.

{
  clean();
}

Member Function Documentation

abort()

virtual void dunedaq::conffwk::ConfigurationImpl::abort ( )

pure virtual

Abort database changes.

Implemented in dunedaq::oksconflibs::OksConfiguration.

add_include()

virtual void dunedaq::conffwk::ConfigurationImpl::add_include ( const std::string & db_name, const std::string & include )

pure virtual

Add include file.

Implemented in dunedaq::oksconflibs::OksConfiguration.

clean()

void dunedaq::conffwk::ConfigurationImpl::clean ( )

protectednoexcept

clean cache (e.g. to be used by destructor)

Definition at line 433 of file ConfigurationImpl.cpp.

{
  for (auto& i : m_impl_objects) {
    for (auto& j : *i.second)
      delete j.second;
 
    delete i.second;
  }
 
  m_impl_objects.clear();
 
  for (auto& x : m_tangled_objects)
    delete x;
 
  m_tangled_objects.clear();
}

close_db()

virtual void dunedaq::conffwk::ConfigurationImpl::close_db ( )

pure virtual

Close database implementation.

Implemented in dunedaq::oksconflibs::OksConfiguration.

commit()

virtual void dunedaq::conffwk::ConfigurationImpl::commit ( const std::string & log_message )

pure virtual

Commit database changes.

Implemented in dunedaq::oksconflibs::OksConfiguration.

create() [1/3]

virtual void dunedaq::conffwk::ConfigurationImpl::create ( const ConfigObject & at, const std::string & class_name, const std::string & id, ConfigObject & object )

pure virtual

Create object of class by id at file identified by object 'at'.

Implemented in dunedaq::oksconflibs::OksConfiguration.

create() [2/3]

virtual void dunedaq::conffwk::ConfigurationImpl::create ( const std::string & at, const std::string & class_name, const std::string & id, ConfigObject & object )

pure virtual

Create object of class by id at given file.

Implemented in dunedaq::oksconflibs::OksConfiguration.

create() [3/3]

virtual void dunedaq::conffwk::ConfigurationImpl::create ( const std::string & db_name, const std::list< std::string > & includes )

pure virtual

Create database.

Implemented in dunedaq::oksconflibs::OksConfiguration.

destroy()

virtual void dunedaq::conffwk::ConfigurationImpl::destroy ( ConfigObject & object )

pure virtual

Destroy object of class by id.

Implemented in dunedaq::oksconflibs::OksConfiguration.

get() [1/4]

virtual void dunedaq::conffwk::ConfigurationImpl::get ( const ConfigObject & obj_from, const std::string & query, std::vector< ConfigObject > & objects, unsigned long rlevel, const std::vector< std::string > * rclasses )

pure virtual

Get objects according to path.

get() [2/4]

virtual dunedaq::conffwk::class_t * dunedaq::conffwk::ConfigurationImpl::get ( const std::string & class_name, bool direct_only )

pure virtual

Get description of class in accordance with parameters.

Implemented in dunedaq::oksconflibs::OksConfiguration.

get() [3/4]

virtual void dunedaq::conffwk::ConfigurationImpl::get ( const std::string & class_name, const std::string & id, ConfigObject & object, unsigned long rlevel, const std::vector< std::string > * rclasses )

pure virtual

Get object of class by id.

Implemented in dunedaq::oksconflibs::OksConfiguration.

get() [4/4]

virtual void dunedaq::conffwk::ConfigurationImpl::get ( const std::string & class_name, std::vector< ConfigObject > & objects, const std::string & query, unsigned long rlevel, const std::vector< std::string > * rclasses )

pure virtual

Get objects of class according to query.

get_changes()

virtual std::vector< dunedaq::conffwk::Version > dunedaq::conffwk::ConfigurationImpl::get_changes ( )

pure virtual

Get newly available versions.

Implemented in dunedaq::oksconflibs::OksConfiguration.

get_conf_impl_mutex()

std::mutex & dunedaq::conffwk::ConfigurationImpl::get_conf_impl_mutex ( ) const

protected

Is required by reload methods.

Definition at line 451 of file ConfigurationImpl.cpp.

{
  return m_conf->m_impl_mutex;
}

get_impl_object()

ConfigObjectImpl * dunedaq::conffwk::ConfigurationImpl::get_impl_object ( const std::string & class_name, const std::string & id ) const

protectednoexcept

get object from cache

Definition at line 309 of file ConfigurationImpl.cpp.

{
 
  conffwk::pmap<conffwk::map<ConfigObjectImpl*>*>::const_iterator i = m_impl_objects.find(&name);
 
  const std::string* class_name = nullptr;
 
  if (i != m_impl_objects.end()) {
    conffwk::map<ConfigObjectImpl*>::const_iterator j = i->second->find(id);
 
    if (j != i->second->end()) {
      p_number_of_cache_hits++;
      TLOG_DEBUG(4) << "\n  * found the object with id = \'" << id << "\' in class \'" << name << '\'';
      return j->second;
    }
 
    class_name = i->first;
 
    // prepare and print out debug message
 
    if (ers::debug_level() >= 4) {
      TLOG_DEBUG(40) << " * there is no object with id = \'" << id << "\' found in the class \'" << name
                     << "\' that has " << i->second->size() << " objects in cache: ";
      for (j = i->second->begin(); j != i->second->end(); ++j) {
        TLOG_DEBUG(40) << '\'' << j->first << '\'';
      }
    }
 
  } else {
    class_name = &DalFactory::instance().get_known_class_name_ref(name);
    TLOG_DEBUG(40) << "  * there is no object with id = \'" << id << "\' found in the class \'" << name
                   << "\' that has no objects in cache";
  }
 
  // check implementation objects of subclasses
 
  if (m_conf) {
    conffwk::fmap<conffwk::fset>::const_iterator subclasses = m_conf->subclasses().find(class_name);
 
    if (subclasses != m_conf->subclasses().end()) {
      for (conffwk::fset::const_iterator k = subclasses->second.begin(); k != subclasses->second.end(); ++k) {
        i = m_impl_objects.find(*k);
        if (i != m_impl_objects.end()) {
          conffwk::map<ConfigObjectImpl*>::const_iterator j = i->second->find(id);
 
          if (j != i->second->end()) {
            p_number_of_cache_hits++;
            TLOG_DEBUG(40) << "  * found the object with id = \'" << id << "\' in class \'" << *k << '\'';
 
            return j->second;
          }
 
          // prepare and print out debug message
 
          else if (ers::debug_level() >= 4) {
            TLOG_DEBUG(40) << "  * there is no object with id = \'" << id << "\' found in the class \'" << *k
                           << "\' that has " << i->second->size() << " objects in cache: ";
            for (j = i->second->begin(); j != i->second->end(); ++j) {
              TLOG_DEBUG(40) << '\'' << j->first << '\'';
            }
          }
 
        } else {
          TLOG_DEBUG(40) << "  * there is no object with id = \'" << id << "\' found in the class \'" << *k
                         << "\' that has no objects in cache\n";
        }
      }
    }
 
    TLOG_DEBUG(40) << "  * there is no object \'" << id << "\' in class \'" << name
                   << "\' and it's subclasses, returning NULL ...";
  } else {
    TLOG_DEBUG(40) << "  * there is no object \'" << id << "\' in class \'" << name << "\', returning NULL ...";
  }
 
  return nullptr;
}

get_includes()

virtual void dunedaq::conffwk::ConfigurationImpl::get_includes ( const std::string & db_name, std::list< std::string > & includes ) const

pure virtual

Get included files.

Implemented in dunedaq::oksconflibs::OksConfiguration.

get_superclasses()

virtual void dunedaq::conffwk::ConfigurationImpl::get_superclasses ( conffwk::fmap< conffwk::fset > & schema )

pure virtual

Get inheritance hierarchy.

Implemented in dunedaq::oksconflibs::OksConfiguration.

get_updated_dbs()

virtual void dunedaq::conffwk::ConfigurationImpl::get_updated_dbs ( std::list< std::string > & dbs ) const

pure virtual

Get uncommitted files.

Implemented in dunedaq::oksconflibs::OksConfiguration.

get_versions()

virtual std::vector< dunedaq::conffwk::Version > dunedaq::conffwk::ConfigurationImpl::get_versions ( const std::string & since, const std::string & until, dunedaq::conffwk::Version::QueryType type, bool skip_irrelevant )

pure virtual

Get archived versions.

Implemented in dunedaq::oksconflibs::OksConfiguration.

insert_object()

template<class T, class OBJ>

T * dunedaq::conffwk::ConfigurationImpl::insert_object ( OBJ & obj, const std::string & id, const std::string & class_name )

inlineprotectednoexcept

insert new object (update cache or create-and-insert)

Definition at line 247 of file ConfigurationImpl.hpp.

  {
    ConfigObjectImpl* p = get_impl_object(class_name, id);
 
    if (p == nullptr) {
      p = static_cast<ConfigObjectImpl*>(new T(obj, this));
      put_impl_object(class_name, id, p);
    } else {
      static_cast<T*>(p)->set(obj);
      p->m_state = dunedaq::conffwk::Valid;
    }
 
    return static_cast<T*>(p);
  }

is_writable()

virtual bool dunedaq::conffwk::ConfigurationImpl::is_writable ( const std::string & db_name )

pure virtual

Return write access status.

Implemented in dunedaq::oksconflibs::OksConfiguration.

loaded()

virtual bool dunedaq::conffwk::ConfigurationImpl::loaded ( ) const

pure virtualnoexcept

Check if a database is loaded.

Implemented in dunedaq::oksconflibs::OksConfiguration.

open_db()

virtual void dunedaq::conffwk::ConfigurationImpl::open_db ( const std::string & db_name )

pure virtual

Open database implementation in accordance with given name.

Implemented in dunedaq::oksconflibs::OksConfiguration.

prefetch_all_data()

virtual void dunedaq::conffwk::ConfigurationImpl::prefetch_all_data ( )

pure virtual

Prefetch all data into client cache.

Implemented in dunedaq::oksconflibs::OksConfiguration.

print_cache_info()

void dunedaq::conffwk::ConfigurationImpl::print_cache_info ( )

noexcept

Print profiling information about objects in cache.

Definition at line 298 of file ConfigurationImpl.cpp.

{
  std::cout << "Configuration implementation profiler report:\n"
               "  number of read objects: "
            << p_number_of_object_read
            << "\n"
               "  number of cache hits: "
            << p_number_of_cache_hits << std::endl;
}

print_profiling_info()

virtual void dunedaq::conffwk::ConfigurationImpl::print_profiling_info ( )

pure virtualnoexcept

Print implementation specific profiling information.

Implemented in dunedaq::oksconflibs::OksConfiguration.

put_impl_object()

void dunedaq::conffwk::ConfigurationImpl::put_impl_object ( const std::string & class_name, const std::string & id, ConfigObjectImpl * obj )

protectednoexcept

put object to cache

Definition at line 388 of file ConfigurationImpl.cpp.

{
  p_number_of_object_read++;
 
  conffwk::pmap<conffwk::map<ConfigObjectImpl*>*>::iterator i = m_impl_objects.find(&name);
 
  if (i != m_impl_objects.end()) {
    (*i->second)[id] = obj;
    obj->m_class_name = i->first;
  } else {
    conffwk::map<ConfigObjectImpl*>* m = new conffwk::map<ConfigObjectImpl*>();
    obj->m_class_name = &DalFactory::instance().get_known_class_name_ref(name);
    m_impl_objects[obj->m_class_name] = m;
    (*m)[id] = obj;
  }
}

remove_include()

virtual void dunedaq::conffwk::ConfigurationImpl::remove_include ( const std::string & db_name, const std::string & include )

pure virtual

Remove include file.

Implemented in dunedaq::oksconflibs::OksConfiguration.

rename_impl_object()

void dunedaq::conffwk::ConfigurationImpl::rename_impl_object ( const std::string * class_name, const std::string & old_id, const std::string & new_id )

noexcept

rename object in cache

Definition at line 406 of file ConfigurationImpl.cpp.

{
  conffwk::pmap<conffwk::map<ConfigObjectImpl*>*>::iterator i = m_impl_objects.find(class_name);
 
  if (i != m_impl_objects.end()) {
    conffwk::map<ConfigObjectImpl*>::iterator j = i->second->find(old_id);
 
    if (j != i->second->end()) {
      ConfigObjectImpl*& obj = (*i->second)[new_id];
 
      if (obj != nullptr) {
        obj->m_state = dunedaq::conffwk::Unknown;
        m_tangled_objects.push_back(obj);
      }
 
      obj = j->second;
 
      TLOG_DEBUG(2) << "rename implementation " << (void*)j->second << " of object \'" << old_id << '@' << *class_name
                    << "\' to \'" << new_id << '\'';
      i->second->erase(j);
    }
  }
}

set()

void dunedaq::conffwk::ConfigurationImpl::set ( Configuration * db )

inlinenoexcept

set configuration object

Definition at line 278 of file ConfigurationImpl.hpp.

{ m_conf = db; }

set_commit_credentials()

virtual void dunedaq::conffwk::ConfigurationImpl::set_commit_credentials ( const std::string & user, const std::string & password )

pure virtual

Set commit credentials.

Implemented in dunedaq::oksconflibs::OksConfiguration.

subscribe()

virtual void dunedaq::conffwk::ConfigurationImpl::subscribe ( const std::set< std::string > & class_names, const std::map< std::string, std::set< std::string > > & objs, notify cb, pre_notify pre_cb )

pure virtual

Subscribe on database changes.

test_object()

virtual bool dunedaq::conffwk::ConfigurationImpl::test_object ( const std::string & class_name, const std::string & id, unsigned long rlevel, const std::vector< std::string > * rclasses )

pure virtual

Test object existence (used by Python binding).

Implemented in dunedaq::oksconflibs::OksConfiguration.

unsubscribe()

virtual void dunedaq::conffwk::ConfigurationImpl::unsubscribe ( )

pure virtual

Remove subscription on database changes.

Implemented in dunedaq::oksconflibs::OksConfiguration.

Friends And Related Symbol Documentation

ConfigObject

friend class ConfigObject

friend

Definition at line 51 of file ConfigurationImpl.hpp.

ConfigObjectImpl

friend class ConfigObjectImpl

friend

Definition at line 52 of file ConfigurationImpl.hpp.

Configuration

friend class Configuration

friend

Definition at line 53 of file ConfigurationImpl.hpp.

Member Data Documentation

m_conf

Configuration* dunedaq::conffwk::ConfigurationImpl::m_conf

protected

Configuration pointer is needed for notification on changes, e.g. in case of subscription or an object deletion.

Definition at line 269 of file ConfigurationImpl.hpp.

m_impl_objects

conffwk::pmap<conffwk::map<ConfigObjectImpl*>*> dunedaq::conffwk::ConfigurationImpl::m_impl_objects

private

cache of implementation objects (class-name::->object_id->implementation)

Definition at line 229 of file ConfigurationImpl.hpp.

m_tangled_objects

std::vector<ConfigObjectImpl*> dunedaq::conffwk::ConfigurationImpl::m_tangled_objects

private

Definition at line 230 of file ConfigurationImpl.hpp.

p_number_of_cache_hits

unsigned long dunedaq::conffwk::ConfigurationImpl::p_number_of_cache_hits

mutableprivate

Definition at line 232 of file ConfigurationImpl.hpp.

p_number_of_object_read

unsigned long dunedaq::conffwk::ConfigurationImpl::p_number_of_object_read

mutableprivate

Definition at line 233 of file ConfigurationImpl.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/conffwk/include/conffwk/ConfigurationImpl.hpp
• /github/workspace/dunedaq/sourcecode/conffwk/src/ConfigurationImpl.cpp