OksConfiguration.hpp

Go to the documentation of this file.

//
// DUNE DAQ modification notice:
// This file has been modified from the original ATLAS oksconfig source for the DUNE DAQ project.
// Fork baseline commit: oksconfig-03-02-00 (2021-04-20).
// Renamed since fork: yes (from oksconfig/OksConfiguration.h to include/oksconflibs/OksConfiguration.hpp).
//
 
// this is -*- c++ -*-
#ifndef OKSCONFLIBS_OKSCONFLIBSURATION_H_
#define OKSCONFLIBS_OKSCONFLIBSURATION_H_
 
//
// $Id$
//
 
#include <string>
#include <list>
#include <set>
#include <thread>
 
#include "conffwk/ConfigurationImpl.hpp"
 
namespace dunedaq {
namespace oks {
  // forward declarations for OKS classes
  class OksKernel;
  class OksObject;
  class OksClass;
  class OksFile;
}
 
namespace oksconflibs {
 
  // forward declaration 
class OksConfigObject;
struct OksConfigurationCheckDB;
 
 
class OksConfiguration : public conffwk::ConfigurationImpl {
 
  friend class OksConfigObject;
  friend struct OksConfigurationCheckDB;
  friend class ResubscribeGuard;
 
  public:
 
    OksConfiguration() noexcept : m_kernel (0), m_fn (0), m_oks_kernel_no_repo(false), m_check_db_obj (0), m_check_db_thread (0), m_repo_error_count(0) { init_env(); }
    virtual ~OksConfiguration() { close_db(); }
 
    typedef std::map< std::string , std::set<std::string> > SMap;
 
  public:
 
    virtual bool test_object(const std::string& class_name, const std::string& name, unsigned long rlevel, const std::vector<std::string> * rclasses);
    virtual void get(const std::string& class_name, const std::string& name, conffwk::ConfigObject& object, unsigned long rlevel, const std::vector<std::string> * rclasses);
    virtual void get(const std::string& class_name, std::vector<conffwk::ConfigObject>& objects, const std::string& query, unsigned long rlevel, const std::vector<std::string> * rclasses);
    virtual void get(const conffwk::ConfigObject& obj_from, const std::string& query, std::vector<conffwk::ConfigObject>& objects, unsigned long rlevel, const std::vector<std::string> * rclasses);
    virtual conffwk::class_t * get(const std::string& class_name, bool direct_only);
    virtual void get_superclasses(conffwk::fmap<conffwk::fset>& schema);
 
    virtual void create(const std::string& at, const std::string& class_name, const std::string& id, conffwk::ConfigObject& object);
    virtual void create(const conffwk::ConfigObject& at, const std::string& class_name, const std::string& id, conffwk::ConfigObject& object);
    virtual void destroy(conffwk::ConfigObject& object);
 
    virtual void open_db(const std::string& db_name);
    virtual void close_db() { close_database(true); }
    virtual bool loaded() const noexcept { return (m_kernel != 0); }
    virtual void create(const std::string& db_name, const std::list<std::string>& includes);
    virtual bool is_writable(const std::string& db_name);
    virtual void add_include(const std::string& db_name, const std::string& include);
    virtual void remove_include(const std::string& db_name, const std::string& include);
    virtual void get_includes(const std::string& db_name, std::list<std::string>& includes) const;
    virtual void get_updated_dbs(std::list<std::string>& dbs) const;
    virtual void set_commit_credentials(const std::string& user, const std::string& password);
    virtual void commit(const std::string& why);
    virtual void abort();
    virtual void prefetch_all_data() { ; } // nothing to do with OKS data already in-memory
    virtual std::vector<dunedaq::conffwk::Version> get_changes();
    virtual std::vector<dunedaq::conffwk::Version> get_versions(const std::string& since, const std::string& until, dunedaq::conffwk::Version::QueryType type, bool skip_irrelevant);
 
    virtual void subscribe(const std::set<std::string>& class_names, const SMap& objs, ConfigurationImpl::notify cb, ConfigurationImpl::pre_notify pre_cb);
    virtual void unsubscribe();
 
    virtual void print_profiling_info() noexcept;
 
 
  protected:
 
    void create(oks::OksFile * at, const std::string& class_name, const std::string& id, conffwk::ConfigObject& object);
 
  private:
 
    virtual void check_db();
 
    void close_database(bool unsubscribe);
 
 
  public:
 
    const oks::OksKernel& get_oks_kernel() const { return *m_kernel; }  // required by Java oksconflibs
 
 
  protected:
 
    oks::OksKernel * m_kernel;
    conffwk::ConfigurationImpl::notify m_fn;
    conffwk::ConfigurationImpl::pre_notify m_pre_fn;
    std::set<std::string> m_class_names;
    SMap m_objects;
    bool m_oks_kernel_silence;
    bool m_oks_kernel_no_repo;
 
      // read oks::OksKernel parameters from environment (silence mode)
 
    void init_env();
 
 
    OksConfigObject * new_object(oks::OksObject * obj) noexcept;
 
 
 
      // keep information about changed objects
 
    std::list<oks::OksObject *> m_created;
    std::set<oks::OksObject *> m_modified;
    std::map<std::string, std::set<std::string> > m_removed;
 
    void subscribe();
 
    static void create_notify(oks::OksObject *, void *) noexcept;
    static void change_notify(oks::OksObject *, void *) noexcept;
    static void delete_notify(oks::OksObject *, void *) noexcept;
 
    OksConfigurationCheckDB * m_check_db_obj;
    std::thread * m_check_db_thread;
 
    std::string m_user;
    std::string m_password;
 
 
      // keep information about created files
 
    std::set<oks::OksFile *> m_created_files;
 
 
      //
 
    unsigned int m_repo_error_count;
 
};
 
} // namespace oksconflibs
} // namespace dunedaq
 
#endif // OKSCONFLIBS_OKSCONFLIBSURATION_H_