2012-05-10 12:06:41 +02:00
|
|
|
/******************************************************************************
|
|
|
|
* Icinga 2 *
|
|
|
|
* Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/) *
|
|
|
|
* *
|
|
|
|
* This program is free software; you can redistribute it and/or *
|
|
|
|
* modify it under the terms of the GNU General Public License *
|
|
|
|
* as published by the Free Software Foundation; either version 2 *
|
|
|
|
* of the License, or (at your option) any later version. *
|
|
|
|
* *
|
|
|
|
* This program is distributed in the hope that it will be useful, *
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
|
|
* GNU General Public License for more details. *
|
|
|
|
* *
|
|
|
|
* You should have received a copy of the GNU General Public License *
|
|
|
|
* along with this program; if not, write to the Free Software Foundation *
|
2012-05-11 13:33:57 +02:00
|
|
|
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
|
2012-05-10 12:06:41 +02:00
|
|
|
******************************************************************************/
|
|
|
|
|
2012-07-30 10:17:29 +02:00
|
|
|
#ifndef DYNAMICOBJECT_H
|
|
|
|
#define DYNAMICOBJECT_H
|
2012-03-31 15:18:09 +02:00
|
|
|
|
|
|
|
namespace icinga
|
|
|
|
{
|
|
|
|
|
2012-09-17 13:35:55 +02:00
|
|
|
/**
|
|
|
|
* The type of an attribute for a DynamicObject.
|
2012-09-19 12:32:39 +02:00
|
|
|
*
|
|
|
|
* @ingroup base
|
2012-09-17 13:35:55 +02:00
|
|
|
*/
|
2013-02-26 10:13:54 +01:00
|
|
|
enum AttributeType
|
2012-08-02 09:38:08 +02:00
|
|
|
{
|
|
|
|
Attribute_Transient = 1,
|
|
|
|
|
|
|
|
/* Unlike transient attributes local attributes are persisted
|
|
|
|
* in the program state file. */
|
|
|
|
Attribute_Local = 2,
|
|
|
|
|
|
|
|
/* Replicated attributes are sent to other daemons for which
|
|
|
|
* replication is enabled. */
|
|
|
|
Attribute_Replicated = 4,
|
|
|
|
|
|
|
|
/* Attributes read from the config file are implicitly marked
|
|
|
|
* as config attributes. */
|
|
|
|
Attribute_Config = 8,
|
2012-08-03 23:03:58 +02:00
|
|
|
|
|
|
|
/* Combination of all attribute types */
|
|
|
|
Attribute_All = Attribute_Transient | Attribute_Local | Attribute_Replicated | Attribute_Config
|
2012-08-02 09:38:08 +02:00
|
|
|
};
|
|
|
|
|
2013-02-26 10:13:54 +01:00
|
|
|
class AttributeBase
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
AttributeBase(void)
|
|
|
|
: m_Value()
|
|
|
|
{ }
|
|
|
|
|
|
|
|
void InternalSet(const Value& value)
|
|
|
|
{
|
|
|
|
m_Value = value;
|
|
|
|
}
|
|
|
|
|
|
|
|
const Value& InternalGet(void) const
|
|
|
|
{
|
|
|
|
return m_Value;
|
|
|
|
}
|
|
|
|
|
|
|
|
operator Value(void) const
|
|
|
|
{
|
|
|
|
return InternalGet();
|
|
|
|
}
|
|
|
|
|
|
|
|
bool IsEmpty(void) const
|
|
|
|
{
|
|
|
|
return InternalGet().IsEmpty();
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
Value m_Value;
|
|
|
|
};
|
|
|
|
|
|
|
|
template<typename T>
|
|
|
|
class Attribute : public AttributeBase
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
void Set(const T& value)
|
|
|
|
{
|
|
|
|
InternalSet(value);
|
|
|
|
}
|
|
|
|
|
|
|
|
Attribute<T>& operator=(const T& rhs)
|
|
|
|
{
|
|
|
|
Set(rhs);
|
2013-02-26 10:57:44 +01:00
|
|
|
return *this;
|
2013-02-26 10:13:54 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
T Get(void) const
|
|
|
|
{
|
|
|
|
if (IsEmpty())
|
|
|
|
return T();
|
|
|
|
|
|
|
|
return InternalGet();
|
|
|
|
}
|
|
|
|
|
|
|
|
operator T(void) const
|
|
|
|
{
|
|
|
|
return Get();
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2012-09-17 13:35:55 +02:00
|
|
|
/**
|
|
|
|
* An attribute for a DynamicObject.
|
2012-09-19 12:32:39 +02:00
|
|
|
*
|
|
|
|
* @ingroup base
|
2012-09-17 13:35:55 +02:00
|
|
|
*/
|
2013-02-26 10:13:54 +01:00
|
|
|
struct AttributeHolder
|
2012-08-02 09:38:08 +02:00
|
|
|
{
|
2013-02-26 10:13:54 +01:00
|
|
|
AttributeType m_Type; /**< The type of the attribute. */
|
|
|
|
double m_Tx; /**< The timestamp of the last value change. */
|
|
|
|
bool m_OwnsAttribute; /**< Whether we own the Data pointer. */
|
|
|
|
AttributeBase *m_Attribute; /**< The current value of the attribute. */
|
|
|
|
|
|
|
|
AttributeHolder(AttributeType type, AttributeBase *boundAttribute = NULL)
|
|
|
|
: m_Type(type), m_Tx(0)
|
|
|
|
{
|
|
|
|
if (boundAttribute) {
|
|
|
|
m_Attribute = boundAttribute;
|
|
|
|
m_OwnsAttribute = false;
|
|
|
|
} else {
|
|
|
|
m_Attribute = new Attribute<Value>();
|
|
|
|
m_OwnsAttribute = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
AttributeHolder(const AttributeHolder& other)
|
|
|
|
{
|
|
|
|
m_Type = other.m_Type;
|
|
|
|
m_Tx = other.m_Tx;
|
|
|
|
m_OwnsAttribute = other.m_OwnsAttribute;
|
|
|
|
|
|
|
|
if (other.m_OwnsAttribute) {
|
|
|
|
m_Attribute = new Attribute<Value>();
|
|
|
|
m_Attribute->InternalSet(other.m_Attribute->InternalGet());
|
|
|
|
} else {
|
|
|
|
m_Attribute = other.m_Attribute;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
~AttributeHolder(void)
|
|
|
|
{
|
|
|
|
if (m_OwnsAttribute)
|
|
|
|
delete m_Attribute;
|
|
|
|
}
|
|
|
|
|
|
|
|
void Bind(AttributeBase *boundAttribute)
|
|
|
|
{
|
|
|
|
assert(m_OwnsAttribute);
|
|
|
|
boundAttribute->InternalSet(m_Attribute->InternalGet());
|
|
|
|
m_Attribute = boundAttribute;
|
|
|
|
m_OwnsAttribute = false;
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetValue(double tx, const Value& value)
|
|
|
|
{
|
|
|
|
m_Tx = tx;
|
|
|
|
m_Attribute->InternalSet(value);
|
|
|
|
}
|
|
|
|
|
|
|
|
Value GetValue(void) const
|
|
|
|
{
|
|
|
|
return m_Attribute->InternalGet();
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetType(AttributeType type)
|
|
|
|
{
|
|
|
|
m_Type = type;
|
|
|
|
}
|
|
|
|
|
|
|
|
AttributeType GetType(void) const
|
|
|
|
{
|
|
|
|
return m_Type;
|
|
|
|
}
|
|
|
|
|
|
|
|
double GetTx(void) const
|
|
|
|
{
|
|
|
|
return m_Tx;
|
|
|
|
}
|
2012-08-02 09:38:08 +02:00
|
|
|
};
|
|
|
|
|
2012-12-04 08:42:24 +01:00
|
|
|
class DynamicType;
|
|
|
|
|
2012-06-30 15:22:51 +02:00
|
|
|
/**
|
2012-09-17 13:35:55 +02:00
|
|
|
* A dynamic object that can be instantiated from the configuration file
|
|
|
|
* and that supports attribute replication to remote application instances.
|
2012-06-30 15:22:51 +02:00
|
|
|
*
|
|
|
|
* @ingroup base
|
|
|
|
*/
|
2012-07-30 10:17:29 +02:00
|
|
|
class I2_BASE_API DynamicObject : public Object
|
2012-03-31 15:18:09 +02:00
|
|
|
{
|
|
|
|
public:
|
2012-07-30 10:17:29 +02:00
|
|
|
typedef shared_ptr<DynamicObject> Ptr;
|
|
|
|
typedef weak_ptr<DynamicObject> WeakPtr;
|
2012-03-31 15:18:09 +02:00
|
|
|
|
2013-02-26 10:13:54 +01:00
|
|
|
typedef map<String, AttributeHolder, string_iless> AttributeMap;
|
2012-08-02 09:38:08 +02:00
|
|
|
typedef AttributeMap::iterator AttributeIterator;
|
|
|
|
typedef AttributeMap::const_iterator AttributeConstIterator;
|
2012-03-31 15:18:09 +02:00
|
|
|
|
2012-08-02 09:38:08 +02:00
|
|
|
DynamicObject(const Dictionary::Ptr& serializedObject);
|
2013-02-08 23:40:28 +01:00
|
|
|
~DynamicObject(void);
|
2012-06-12 09:36:18 +02:00
|
|
|
|
2013-02-18 14:40:24 +01:00
|
|
|
static void Initialize(void);
|
|
|
|
|
2012-08-02 09:38:08 +02:00
|
|
|
Dictionary::Ptr BuildUpdate(double sinceTx, int attributeTypes) const;
|
2012-08-03 23:03:58 +02:00
|
|
|
void ApplyUpdate(const Dictionary::Ptr& serializedUpdate, int allowedTypes);
|
2012-06-12 09:36:18 +02:00
|
|
|
|
2013-02-26 10:13:54 +01:00
|
|
|
void RegisterAttribute(const String& name, AttributeType type, AttributeBase *boundAttribute = NULL);
|
2012-06-12 09:36:18 +02:00
|
|
|
|
2012-08-03 13:19:55 +02:00
|
|
|
void Set(const String& name, const Value& data);
|
2012-09-03 10:28:14 +02:00
|
|
|
void Touch(const String& name);
|
2012-08-03 13:19:55 +02:00
|
|
|
Value Get(const String& name) const;
|
2012-07-14 12:44:37 +02:00
|
|
|
|
2012-08-02 09:38:08 +02:00
|
|
|
bool HasAttribute(const String& name) const;
|
2012-07-14 15:59:59 +02:00
|
|
|
|
2013-02-26 10:13:54 +01:00
|
|
|
void BindAttribute(const String& name, Value *boundValue);
|
|
|
|
|
|
|
|
void ClearAttributesByType(AttributeType type);
|
2012-08-02 09:38:08 +02:00
|
|
|
|
2013-02-17 19:14:34 +01:00
|
|
|
static signals2::signal<void (const DynamicObject::Ptr&)> OnRegistered;
|
|
|
|
static signals2::signal<void (const DynamicObject::Ptr&)> OnUnregistered;
|
2013-02-19 12:17:31 +01:00
|
|
|
static signals2::signal<void (double, const set<DynamicObject::WeakPtr>&)> OnTransactionClosing;
|
2013-02-27 12:44:51 +01:00
|
|
|
static signals2::signal<void (double, const DynamicObject::Ptr&)> OnFlushObject;
|
2012-08-02 09:38:08 +02:00
|
|
|
|
2013-02-19 07:26:52 +01:00
|
|
|
ScriptTask::Ptr MakeMethodTask(const String& method,
|
|
|
|
const vector<Value>& arguments);
|
2012-08-02 09:38:08 +02:00
|
|
|
|
2012-12-04 08:42:24 +01:00
|
|
|
shared_ptr<DynamicType> GetType(void) const;
|
2012-08-02 09:38:08 +02:00
|
|
|
String GetName(void) const;
|
2012-06-12 09:36:18 +02:00
|
|
|
|
|
|
|
bool IsLocal(void) const;
|
|
|
|
bool IsAbstract(void) const;
|
2013-02-26 10:58:32 +01:00
|
|
|
bool IsRegistered(void) const;
|
2012-05-09 10:15:51 +02:00
|
|
|
|
2012-08-02 09:38:08 +02:00
|
|
|
void SetSource(const String& value);
|
|
|
|
String GetSource(void) const;
|
2012-07-02 14:38:37 +02:00
|
|
|
|
2013-02-19 23:02:08 +01:00
|
|
|
void Flush(void);
|
|
|
|
|
2012-08-02 09:38:08 +02:00
|
|
|
void Register(void);
|
2012-06-12 09:36:18 +02:00
|
|
|
void Unregister(void);
|
|
|
|
|
2012-09-28 10:39:28 +02:00
|
|
|
virtual void Start(void);
|
|
|
|
|
2013-02-02 14:28:11 +01:00
|
|
|
const AttributeMap& GetAttributes(void) const;
|
2013-02-08 21:05:08 +01:00
|
|
|
|
2013-02-20 19:52:25 +01:00
|
|
|
void SetEventSafe(bool initialized);
|
|
|
|
bool GetEventSafe(void) const;
|
2013-02-18 23:44:24 +01:00
|
|
|
|
2012-08-02 09:38:08 +02:00
|
|
|
static DynamicObject::Ptr GetObject(const String& type, const String& name);
|
2012-05-21 23:42:54 +02:00
|
|
|
|
2012-08-02 09:38:08 +02:00
|
|
|
static void DumpObjects(const String& filename);
|
|
|
|
static void RestoreObjects(const String& filename);
|
2012-08-07 13:08:14 +02:00
|
|
|
static void DeactivateObjects(void);
|
2012-07-24 13:13:02 +02:00
|
|
|
|
2012-08-02 09:38:08 +02:00
|
|
|
static double GetCurrentTx(void);
|
2012-07-27 16:05:02 +02:00
|
|
|
|
2012-08-03 23:03:58 +02:00
|
|
|
protected:
|
2013-02-20 19:52:25 +01:00
|
|
|
virtual void OnRegistrationCompleted(void);
|
2012-08-03 23:03:58 +02:00
|
|
|
virtual void OnAttributeChanged(const String& name, const Value& oldValue);
|
|
|
|
|
2012-05-21 23:42:54 +02:00
|
|
|
private:
|
2013-02-08 23:40:28 +01:00
|
|
|
void InternalSetAttribute(const String& name, const Value& data, double tx, bool allowEditConfig = false);
|
2012-08-02 09:38:08 +02:00
|
|
|
Value InternalGetAttribute(const String& name) const;
|
2013-02-08 23:40:28 +01:00
|
|
|
void SendLocalUpdateEvents(void);
|
2012-08-02 09:38:08 +02:00
|
|
|
|
|
|
|
AttributeMap m_Attributes;
|
2013-02-08 23:40:28 +01:00
|
|
|
map<String, Value, string_iless> m_ModifiedAttributes;
|
2012-08-02 09:38:08 +02:00
|
|
|
double m_ConfigTx;
|
2012-06-12 09:36:18 +02:00
|
|
|
|
2013-02-26 10:13:54 +01:00
|
|
|
Attribute<String> m_Name;
|
|
|
|
Attribute<String> m_Type;
|
|
|
|
Attribute<bool> m_Local;
|
|
|
|
Attribute<bool> m_Abstract;
|
|
|
|
Attribute<String> m_Source;
|
|
|
|
Attribute<Dictionary::Ptr> m_Methods;
|
|
|
|
|
2013-02-26 10:58:32 +01:00
|
|
|
bool m_Registered;
|
2013-02-20 19:52:25 +01:00
|
|
|
bool m_EventSafe;
|
2013-02-18 23:44:24 +01:00
|
|
|
|
2012-08-02 09:38:08 +02:00
|
|
|
static double m_CurrentTx;
|
2012-07-24 13:13:02 +02:00
|
|
|
|
2013-02-19 23:02:08 +01:00
|
|
|
static void NewTx(void);
|
|
|
|
|
2013-02-08 23:40:28 +01:00
|
|
|
/* This has to be a set of raw pointers because the DynamicObject
|
|
|
|
* constructor has to be able to insert objects into this list. */
|
2013-02-19 12:17:31 +01:00
|
|
|
static set<DynamicObject::WeakPtr> m_ModifiedObjects;
|
2013-02-18 14:40:24 +01:00
|
|
|
static boost::mutex m_TransactionMutex;
|
|
|
|
static boost::once_flag m_TransactionOnce;
|
|
|
|
static Timer::Ptr m_TransactionTimer;
|
2013-02-14 14:58:26 +01:00
|
|
|
|
2013-02-27 12:44:51 +01:00
|
|
|
friend class DynamicType; /* for OnRegistrationCompleted. */
|
2012-07-27 16:05:02 +02:00
|
|
|
};
|
2012-07-02 19:25:33 +02:00
|
|
|
|
2012-03-31 15:18:09 +02:00
|
|
|
}
|
|
|
|
|
2012-07-30 10:17:29 +02:00
|
|
|
#endif /* DYNAMICOBJECT_H */
|