componentMetricsIf.hpp

Go to the documentation of this file.

 
#ifndef RTCTK_COMPONENTFRAMEWORK_COMPONENTMETRICSIF_HPP
#define RTCTK_COMPONENTFRAMEWORK_COMPONENTMETRICSIF_HPP
#include <iosfwd>
#include <string>
#include <sys/types.h>
 
#include <perfc/perfc.hpp>
 
#include <rtctk/componentFramework/exceptions.hpp>
 
namespace rtctk::componentFramework {
 
class MetricConflictException : public RtctkException {
    using RtctkException::RtctkException;
};
 
class CounterMetricInfo {
public:
    explicit CounterMetricInfo(std::string id, std::string description) noexcept;
 
    std::string const& GetId() const noexcept {
        return m_id;
    }
    std::string const& GetDescription() const noexcept {
        return m_description;
    }
 
private:
    std::string m_id;
    std::string m_description;
};
 
class ThreadMetricInfo {
public:
    explicit ThreadMetricInfo(std::string id, std::string description) noexcept;
 
    std::string const& GetId() const noexcept {
        return m_id;
    }
    std::string const& GetDescription() const noexcept {
        return m_description;
    }
 
private:
    std::string m_id;
    std::string m_description;
};
 
struct ComponentMetricsParams {
    std::optional<std::chrono::milliseconds> counter_poll_interval;
 
    std::optional<std::chrono::milliseconds> thread_poll_interval;
 
    std::optional<int> monitor_thread_nice;
};
 
bool operator==(ComponentMetricsParams const& lhs, ComponentMetricsParams const& rhs) noexcept;
bool operator!=(ComponentMetricsParams const& lhs, ComponentMetricsParams const& rhs) noexcept;
 
std::ostream& operator<<(std::ostream& os, ComponentMetricsParams const& params);
 
class ComponentMetricsIf {
public:
    virtual ~ComponentMetricsIf() noexcept = default;
 
 
    virtual void StartMonitoring() = 0;
 
    virtual void StopMonitoring() noexcept = 0;
 
    virtual bool IsMonitoring() noexcept = 0;
 
    virtual void UpdateParams(ComponentMetricsParams const& params) = 0;
 
 
    using CounterTypes =
        perfc::CounterTypes<perfc::CounterDouble, perfc::CounterU64, perfc::CounterI64>;
    using CounterVariant = typename CounterTypes::CounterVariant;
 
    [[nodiscard]] virtual perfc::ScopedRegistration
    AddCounter(CounterVariant counter, CounterMetricInfo info) = 0;
 
    virtual bool RemoveCounter(CounterVariant counter) = 0;
 
 
    virtual void AddThread(pid_t thread, ThreadMetricInfo info) = 0;
 
    virtual void RemoveThread(pid_t thread) = 0;
};
 
}  // namespace rtctk::componentFramework
 
#endif  // RTCTK_COMPONENTFRAMEWORK_COMPONENTMETRICSIF_HPP