icinga2/lib/base/configtype.hpp
Julian Brost 4b18f62a11 Add ConfigType::BeforeOnAllConfigLoaded signal
Allows to hook into the config loading process just before OnAllConfigLoaded()
is called on a bunch of individual config objects. Allows doing some operations
more efficiently at once for all objects.

Intended use: when adding a number of dependencies, it has to be checked
whether this uses any cycles. This can be done more efficiently if all
dependencies are checked at once. So far, this is with a case-distinction for
initially loaded files in DaemonUtility::LoadConfigFiles() and for dependencies
created by runtime updates in Dependency::OnAllConfigLoaded(). The mechanism
added by this commit allows to unify the handling of both cases (done in a
following commit).
2025-03-12 11:53:30 +01:00

74 lines
1.9 KiB
C++

/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */
#ifndef CONFIGTYPE_H
#define CONFIGTYPE_H
#include "base/i2-base.hpp"
#include "base/object.hpp"
#include "base/type.hpp"
#include "base/dictionary.hpp"
#include <shared_mutex>
#include <unordered_map>
#include <boost/signals2.hpp>
namespace icinga
{
class ConfigObject;
class ConfigItems;
class ConfigType
{
public:
virtual ~ConfigType();
intrusive_ptr<ConfigObject> GetObject(const String& name) const;
void RegisterObject(const intrusive_ptr<ConfigObject>& object);
void UnregisterObject(const intrusive_ptr<ConfigObject>& object);
std::vector<intrusive_ptr<ConfigObject> > GetObjects() const;
template<typename T>
static TypeImpl<T> *Get()
{
typedef TypeImpl<T> ObjType;
return static_cast<ObjType *>(T::TypeInstance.get());
}
template<typename T>
static std::vector<intrusive_ptr<T> > GetObjectsByType()
{
std::vector<intrusive_ptr<ConfigObject> > objects = GetObjectsHelper(T::TypeInstance.get());
std::vector<intrusive_ptr<T> > result;
result.reserve(objects.size());
for (const auto& object : objects) {
result.push_back(static_pointer_cast<T>(object));
}
return result;
}
int GetObjectCount() const;
/**
* Signal that allows hooking into the config loading process just before ConfigObject::OnAllConfigLoaded() is
* called for a bunch of objects. A vector of pointers to these objects is passed as an argument. All elements
* are of the object type the signal is called on.
*/
boost::signals2::signal<void (const ConfigItems&)> BeforeOnAllConfigLoaded;
private:
typedef std::unordered_map<String, intrusive_ptr<ConfigObject> > ObjectMap;
typedef std::vector<intrusive_ptr<ConfigObject> > ObjectVector;
mutable std::shared_timed_mutex m_Mutex;
ObjectMap m_ObjectMap;
ObjectVector m_ObjectVector;
static std::vector<intrusive_ptr<ConfigObject> > GetObjectsHelper(Type *type);
};
}
#endif /* CONFIGTYPE_H */