aboutsummaryrefslogtreecommitdiffstats
path: root/metrics/src/vespa/metrics/updatehook.h
blob: aced45b91c96a85db87481f9c3b2bf90355df9fc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once

#include <vespa/vespalib/util/time.h>
#include <mutex>

namespace metrics {

using time_point = vespalib::system_time;

class MetricLockGuard {
public:
    MetricLockGuard(std::mutex & mutex);
    MetricLockGuard(const MetricLockGuard &) = delete;
    MetricLockGuard & operator =(const MetricLockGuard &) = delete;
    MetricLockGuard(MetricLockGuard &&) = default;
    MetricLockGuard & operator =(MetricLockGuard &&) = default;
    ~MetricLockGuard();

    bool owns(const std::mutex &) const;
    operator std::unique_lock<std::mutex> & () { return _guard; }
private:
    std::unique_lock<std::mutex> _guard;
};

class MetricManager;

class UpdateHook {
public:
    using MetricLockGuard = metrics::MetricLockGuard;
    UpdateHook(const char* name, time_point::duration period)
        : _name(name),
          _period(period),
          _nextCall()
    {}
    virtual ~UpdateHook() = default;
    virtual void updateMetrics(const MetricLockGuard & guard) = 0;
    const char* getName() const { return _name; }
    void updateNextCall() { updateNextCall(_nextCall); }
    void updateNextCall(time_point now) { setNextCall(now + _period); }
    bool is_periodic() const noexcept { return _period != time_point::duration::zero(); }
    bool expired(time_point now) { return _nextCall <= now; }
    bool has_valid_expiry() const noexcept { return _nextCall != time_point(); }
    time_point::duration getPeriod() const noexcept { return _period; }
    time_point getNextCall() const noexcept { return _nextCall; }
    void setNextCall(time_point now) { _nextCall = now; }
private:
    const char*               _name;
    const time_point::duration _period;
    time_point                _nextCall;
};

}