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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
* Copyright 2003-2020 The Music Player Daemon Project
* http://www.musicpd.org
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef MPD_PERIOD_CLOCK_HXX
#define MPD_PERIOD_CLOCK_HXX
#include <chrono>
/**
* This is a stopwatch which saves the timestamp of an event, and can
* check whether a specified time span has passed since then.
*/
class PeriodClock {
public:
typedef std::chrono::steady_clock::duration Duration;
typedef Duration Delta;
typedef std::chrono::steady_clock::time_point Stamp;
private:
Stamp last;
public:
/**
* Initializes the object, setting the last time stamp to "0",
* i.e. a Check() will always succeed. If you do not want this
* default behaviour, call Update() immediately after creating the
* object.
*/
constexpr
PeriodClock():last() {}
protected:
static Stamp GetNow() {
return std::chrono::steady_clock::now();
}
constexpr Delta Elapsed(Stamp now) const {
return last == Stamp()
? Delta(-1)
: Delta(now - last);
}
constexpr bool Check(Stamp now, Duration duration) const {
return now >= last + duration;
}
void Update(Stamp now) {
last = now;
}
public:
constexpr bool IsDefined() const {
return last > Stamp();
}
/**
* Resets the clock.
*/
void Reset() {
last = Stamp();
}
/**
* Returns the time elapsed since the last update(). Returns
* a negative value if update() was never called.
*/
Delta Elapsed() const {
return Elapsed(GetNow());
}
/**
* Combines a call to Elapsed() and Update().
*/
Delta ElapsedUpdate() {
const auto now = GetNow();
const auto result = Elapsed(now);
Update(now);
return result;
}
/**
* Checks whether the specified duration has passed since the last
* update.
*
* @param duration the duration
*/
bool Check(Duration duration) const {
return Check(GetNow(), duration);
}
/**
* Updates the time stamp, setting it to the current clock.
*/
void Update() {
Update(GetNow());
}
/**
* Updates the time stamp, setting it to the current clock plus the
* specified offset.
*/
void UpdateWithOffset(Delta offset) {
Update(GetNow() + offset);
}
/**
* Checks whether the specified duration has passed since the last
* update. If yes, it updates the time stamp.
*
* @param duration the duration in milliseconds
*/
bool CheckUpdate(Duration duration) {
Stamp now = GetNow();
if (Check(now, duration)) {
Update(now);
return true;
} else
return false;
}
/**
* Checks whether the specified duration has passed since the last
* update. After that, it updates the time stamp.
*
* @param duration the duration in milliseconds
*/
bool CheckAlwaysUpdate(Duration duration) {
Stamp now = GetNow();
bool ret = Check(now, duration);
Update(now);
return ret;
}
};
#endif