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
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include "mongo/stdx/condition_variable.h"
#include "mongo/stdx/functional.h"
#include "mongo/stdx/mutex.h"
#include "mongo/util/time_support.h"
namespace mongo {
class Date_t;
/**
* An interface for getting the current wall clock time.
*/
class ClockSource {
public:
virtual ~ClockSource() = default;
/**
* Returns the minimum time change that the clock can describe.
*/
virtual Milliseconds getPrecision() = 0;
/**
* Returns the current wall clock time, as defined by this source.
*/
virtual Date_t now() = 0;
/**
* Schedules "action" to run sometime after this clock source reaches "when".
*
* Returns InternalError if this clock source does not implement setAlarm. May also
* return ShutdownInProgress during shutdown. Other errors are also allowed.
*/
virtual Status setAlarm(Date_t when, stdx::function<void()> action) {
return {ErrorCodes::InternalError, "This clock source does not implement setAlarm."};
}
/**
* Returns true if this clock source (loosely) tracks the OS clock used for things
* like condition_variable::wait_until. Virtualized clocks used for testing return
* false here, and should provide an implementation for setAlarm, above.
*/
bool tracksSystemClock() const {
return _tracksSystemClock;
}
/**
* Like cv.wait_until(m, deadline), but uses this ClockSource instead of
* stdx::chrono::system_clock to measure the passage of time.
*/
stdx::cv_status waitForConditionUntil(stdx::condition_variable& cv,
stdx::unique_lock<stdx::mutex>& m,
Date_t deadline);
/**
* Like cv.wait_until(m, deadline, pred), but uses this ClockSource instead of
* stdx::chrono::system_clock to measure the passage of time.
*/
template <typename Pred>
bool waitForConditionUntil(stdx::condition_variable& cv,
stdx::unique_lock<stdx::mutex>& m,
Date_t deadline,
const Pred& pred) {
while (!pred()) {
if (waitForConditionUntil(cv, m, deadline) == stdx::cv_status::timeout) {
return pred();
}
}
return true;
}
/**
* Like cv.wait_for(m, duration, pred), but uses this ClockSource instead of
* stdx::chrono::system_clock to measure the passage of time.
*/
template <typename Duration, typename Pred>
bool waitForConditionFor(stdx::condition_variable& cv,
stdx::unique_lock<stdx::mutex>& m,
Duration duration,
const Pred& pred) {
return waitForConditionUntil(cv, m, now() + duration, pred);
}
protected:
bool _tracksSystemClock = true;
};
} // namespace mongo
|