monitored_duration_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 MONITORED_DURATION_STORE_H
#define MONITORED_DURATION_STORE_H
 
#include <exceptions/exceptions.h>
#include <monitored_duration.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 DuplicateDurationKey : public Exception {
public:
    DuplicateDurationKey(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};
 
struct DurationKeyTag { };
 
struct IntervalStartTag { };
 
typedef boost::multi_index_container<
    // It holds pointers to Lease6 objects.
    MonitoredDurationPtr,
    boost::multi_index::indexed_by<
        // Specification of the first index starts here.
        // This index sorts using composite key
        boost::multi_index::ordered_unique<
            boost::multi_index::tag<DurationKeyTag>,
            boost::multi_index::composite_key<
                MonitoredDuration,
                // The query packet type
                boost::multi_index::const_mem_fun<DurationKey, uint8_t,
                                                  &DurationKey::getQueryType>,
                // The response packet type
                boost::multi_index::const_mem_fun<DurationKey, uint8_t,
                                                  &DurationKey::getResponseType>,
                // The start event label
                boost::multi_index::const_mem_fun<DurationKey, std::string,
                                                  &DurationKey::getStartEventLabel>,
                // The end event label
                boost::multi_index::const_mem_fun<DurationKey, std::string,
                                                  &DurationKey::getStopEventLabel>,
                // The subnet id
                boost::multi_index::const_mem_fun<DurationKey, dhcp::SubnetID,
                                                  &DurationKey::getSubnetId>
            >
        >,
 
        // Specification of the second index starts here.
        // This index sorts durations by current interval start time.
        boost::multi_index::ordered_non_unique<
            boost::multi_index::tag<IntervalStartTag>,
            boost::multi_index::const_mem_fun<MonitoredDuration, Timestamp,
                                              &MonitoredDuration::getCurrentIntervalStart>
        >
    >
> MonitoredDurationContainer;
 
typedef std::vector<MonitoredDurationPtr> MonitoredDurationCollection;
 
typedef boost::shared_ptr<MonitoredDurationCollection> MonitoredDurationCollectionPtr;
 
class MonitoredDurationStore {
public:
    explicit MonitoredDurationStore(uint16_t family, const Duration& interval_duration);
 
    ~MonitoredDurationStore() = default;
 
    MonitoredDurationPtr addDurationSample(DurationKeyPtr key, const Duration& sample);
 
    MonitoredDurationPtr addDuration(DurationKeyPtr key);
 
    MonitoredDurationPtr getDuration(DurationKeyPtr key);
 
    void updateDuration(MonitoredDurationPtr& duration);
 
    void deleteDuration(DurationKeyPtr key);
 
    MonitoredDurationCollectionPtr getAll();
 
    MonitoredDurationPtr getReportsNext();
 
    MonitoredDurationCollectionPtr getOverdueReports(const Timestamp& since = dhcp::PktEvent::now());
 
    void clear();
 
    uint16_t getFamily() {
        return (family_);
    }
 
private:
    void validateKey(const std::string& label, DurationKeyPtr key) const;
 
    uint16_t family_;
 
    Duration interval_duration_;
 
    MonitoredDurationContainer durations_;
 
    const boost::scoped_ptr<std::mutex> mutex_;
};
 
typedef boost::shared_ptr<MonitoredDurationStore> MonitoredDurationStorePtr;
 
} // end of namespace perfmon
} // end of namespace isc
 
#endif