alarm.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_H
#define _ALARM_H
 
#include <dhcp/pkt.h>
#include <dhcpsrv/subnet_id.h>
#include <monitored_duration.h>
 
#include <boost/date_time/posix_time/posix_time.hpp>
 
namespace isc {
namespace perfmon {
 
class Alarm : public DurationKey {
public:
    enum State {
        CLEAR,      // Enabled and not currently triggered
        TRIGGERED,  // High water has been exceeded
        DISABLED    // Disabled
    };
 
    Alarm(uint16_t family, uint8_t query_type, uint8_t response_type,
          const std::string& start_event_label, const std::string& stop_event_label,
          dhcp::SubnetID subnet_id,
          const Duration& low_water, const Duration& high_water, bool enabled = true);
 
    Alarm(const DurationKey& key, const Duration& low_water, const Duration& high_water, bool enabled = true);
 
    virtual ~Alarm() = default;
 
    Duration getLowWater() const {
        return (low_water_);
    }
 
    void setLowWater(const Duration& low_water);
 
    Duration getHighWater() const {
        return (high_water_);
    }
 
    void setHighWater(const Duration& high_water);
 
    State getState() {
        return (state_);
    }
 
    void setState(State state);
 
    Timestamp getStosTime() {
        return (stos_time_);
    }
 
    Timestamp getLastHighWaterReport() {
        return (last_high_water_report_);
    }
 
    void setLastHighWaterReport(const Timestamp& timestamp = dhcp::PktEvent::now()) {
        last_high_water_report_ = timestamp;
    }
 
    void clear();
 
    void disable();
 
    bool checkSample(const Duration& sample, const Duration& report_interval);
 
private:
    Duration low_water_;
 
    Duration high_water_;
 
    State state_;
 
    Timestamp stos_time_;
 
    Timestamp last_high_water_report_;
};
 
typedef boost::shared_ptr<Alarm> AlarmPtr;
 
} // end of namespace isc::perfmon
} // end of namespace isc
 
#endif