alarm_store.h

Go to the documentation of this file.

// Copyright (C) 2024 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef ALARM_STORE_H
#define ALARM_STORE_H
 
#include <exceptions/exceptions.h>
#include <alarm.h>
 
#include <boost/multi_index/indexed_by.hpp>
#include <boost/multi_index/member.hpp>
#include <boost/multi_index/mem_fun.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/composite_key.hpp>
#include <boost/multi_index/sequenced_index.hpp>
#include <boost/multi_index/identity.hpp>
#include <boost/scoped_ptr.hpp>
 
#include <string>
 
namespace isc {
namespace perfmon {
 
class DuplicateAlarm : public Exception {
public:
    DuplicateAlarm(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};
 
struct AlarmPrimaryKeyTag { };
 
typedef boost::multi_index_container<
    // It holds pointers to Lease6 objects.
    AlarmPtr,
    boost::multi_index::indexed_by<
        // Specification of the first index starts here.
        // This index sorts using DurationKey::operators
        boost::multi_index::ordered_unique<
            boost::multi_index::tag<AlarmPrimaryKeyTag>,
            boost::multi_index::identity<DurationKey>
        >
    >
> AlarmContainer;
 
typedef std::vector<AlarmPtr> AlarmCollection;
 
typedef boost::shared_ptr<AlarmCollection> AlarmCollectionPtr;
 
class AlarmStore {
public:
    explicit AlarmStore(uint16_t family);
 
    ~AlarmStore() = default;
 
    AlarmPtr checkDurationSample(DurationKeyPtr key, const Duration& sample,
                                 const Duration& report_interval);
 
    AlarmPtr addAlarm(DurationKeyPtr key, const Duration& low_water,
                      const Duration& high_water, bool enabled = true);
 
    AlarmPtr addAlarm(AlarmPtr alarm);
 
    AlarmPtr getAlarm(DurationKeyPtr key);
 
    void updateAlarm(AlarmPtr& alarm);
 
    void deleteAlarm(DurationKeyPtr key);
 
    AlarmCollectionPtr getAll();
 
    void clear();
 
    uint16_t getFamily() {
        return (family_);
    }
 
private:
    void validateKey(const std::string& label, DurationKeyPtr key) const;
 
    uint16_t family_;
 
    AlarmContainer alarms_;
 
    const boost::scoped_ptr<std::mutex> mutex_;
};
 
typedef boost::shared_ptr<AlarmStore> AlarmStorePtr;
 
} // end of namespace perfmon
} // end of namespace isc
 
#endif