Skip to content

Commit fadafb8

Browse files
author
MarcoFalke
committed
scheduler: Make schedule* methods type safe
1 parent fa70ccc commit fadafb8

File tree

7 files changed

+34
-35
lines changed

7 files changed

+34
-35
lines changed

‎src/init.cpp‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ static const bool DEFAULT_PROXYRANDOMIZE = true;
8686
static const bool DEFAULT_REST_ENABLE = false;
8787
static const bool DEFAULT_STOPAFTERBLOCKIMPORT = false;
8888

89-
// Dump addresses to banlist.dat every 15 minutes (900s)
90-
static constexpr int DUMP_BANS_INTERVAL = 60 * 15;
89+
// How often to dump addresses to banlist.dat
90+
static constexpr std::chrono::minutes DUMP_BANS_INTERVAL{15};
9191

9292

9393
#ifdef WIN32
@@ -1278,7 +1278,7 @@ bool AppInitMain(NodeContext& node)
12781278
// Gather some entropy once per minute.
12791279
node.scheduler->scheduleEvery([]{
12801280
RandAddPeriodic();
1281-
}, 60000);
1281+
}, std::chrono::minutes{1});
12821282

12831283
GetMainSignals().RegisterBackgroundSignalScheduler(*node.scheduler);
12841284

@@ -1863,7 +1863,7 @@ bool AppInitMain(NodeContext& node)
18631863
BanMan* banman = node.banman.get();
18641864
node.scheduler->scheduleEvery([banman]{
18651865
banman->DumpBanlist();
1866-
}, DUMP_BANS_INTERVAL * 1000);
1866+
}, DUMP_BANS_INTERVAL);
18671867

18681868
return true;
18691869
}

‎src/net.cpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ static_assert(MINIUPNPC_API_VERSION >= 10, "miniUPnPc API version >= 10 assumed"
4545

4646
#include <math.h>
4747

48-
// Dump addresses to peers.dat every 15 minutes (900s)
49-
static constexpr int DUMP_PEERS_INTERVAL = 15 * 60;
48+
// How often to dump addresses to peers.dat
49+
static constexpr std::chrono::minutes DUMP_PEERS_INTERVAL{15};
5050

5151
/** Number of DNS seeds to query when the number of connections is low. */
5252
static constexpr int DNSSEEDS_TO_QUERY_AT_ONCE = 3;
@@ -2343,7 +2343,7 @@ bool CConnman::Start(CScheduler& scheduler, const Options& connOptions)
23432343
threadMessageHandler = std::thread(&TraceThread<std::function<void()> >, "msghand", std::function<void()>(std::bind(&CConnman::ThreadMessageHandler, this)));
23442344

23452345
// Dump network addresses
2346-
scheduler.scheduleEvery(std::bind(&CConnman::DumpAddresses, this), DUMP_PEERS_INTERVAL * 1000);
2346+
scheduler.scheduleEvery([this] { DumpAddresses(); }, DUMP_PEERS_INTERVAL);
23472347

23482348
return true;
23492349
}

‎src/net_processing.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1124,7 +1124,7 @@ PeerLogicValidation::PeerLogicValidation(CConnman* connmanIn, BanMan* banman, CS
11241124
// combine them in one function and schedule at the quicker (peer-eviction)
11251125
// timer.
11261126
static_assert(EXTRA_PEER_CHECK_INTERVAL < STALE_CHECK_INTERVAL, "peer eviction timer should be less than stale tip check timer");
1127-
scheduler.scheduleEvery(std::bind(&PeerLogicValidation::CheckForStaleTipAndEvictPeers, this, consensusParams), EXTRA_PEER_CHECK_INTERVAL * 1000);
1127+
scheduler.scheduleEvery([&] { this->CheckForStaleTipAndEvictPeers(consensusParams); }, std::chrono::seconds{EXTRA_PEER_CHECK_INTERVAL});
11281128
}
11291129

11301130
/**

‎src/scheduler.cpp‎

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,6 @@ void CScheduler::schedule(CScheduler::Function f, std::chrono::system_clock::tim
9292
newTaskScheduled.notify_one();
9393
}
9494

95-
void CScheduler::scheduleFromNow(CScheduler::Function f, int64_t deltaMilliSeconds)
96-
{
97-
schedule(f, std::chrono::system_clock::now() + std::chrono::milliseconds(deltaMilliSeconds));
98-
}
99-
10095
void CScheduler::MockForward(std::chrono::seconds delta_seconds)
10196
{
10297
assert(delta_seconds.count() > 0 && delta_seconds < std::chrono::hours{1});
@@ -119,15 +114,15 @@ void CScheduler::MockForward(std::chrono::seconds delta_seconds)
119114
newTaskScheduled.notify_one();
120115
}
121116

122-
static void Repeat(CScheduler* s, CScheduler::Function f, int64_t deltaMilliSeconds)
117+
static void Repeat(CScheduler& s, CScheduler::Function f, std::chrono::milliseconds delta)
123118
{
124119
f();
125-
s->scheduleFromNow(std::bind(&Repeat, s, f, deltaMilliSeconds), deltaMilliSeconds);
120+
s.scheduleFromNow([=, &s] { Repeat(s, f, delta); }, delta);
126121
}
127122

128-
void CScheduler::scheduleEvery(CScheduler::Function f, int64_t deltaMilliSeconds)
123+
void CScheduler::scheduleEvery(CScheduler::Function f, std::chrono::milliseconds delta)
129124
{
130-
scheduleFromNow(std::bind(&Repeat, this, f, deltaMilliSeconds), deltaMilliSeconds);
125+
scheduleFromNow([=] { Repeat(*this, f, delta); }, delta);
131126
}
132127

133128
size_t CScheduler::getQueueInfo(std::chrono::system_clock::time_point &first,

‎src/scheduler.h‎

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
// Usage:
2525
//
2626
// CScheduler* s = new CScheduler();
27-
// s->scheduleFromNow(doSomething, 11); // Assuming a: void doSomething() { }
28-
// s->scheduleFromNow(std::bind(Class::func, this, argument), 3);
27+
// s->scheduleFromNow(doSomething, std::chrono::milliseconds{11}); // Assuming a: void doSomething() { }
28+
// s->scheduleFromNow([=] { this->func(argument); }, std::chrono::milliseconds{3});
2929
// boost::thread* t = new boost::thread(std::bind(CScheduler::serviceQueue, s));
3030
//
3131
// ... then at program shutdown, make sure to call stop() to clean up the thread(s) running serviceQueue:
@@ -46,15 +46,19 @@ class CScheduler
4646
// Call func at/after time t
4747
void schedule(Function f, std::chrono::system_clock::time_point t);
4848

49-
// Convenience method: call f once deltaMilliSeconds from now
50-
void scheduleFromNow(Function f, int64_t deltaMilliSeconds);
49+
/** Call f once after the delta has passed */
50+
void scheduleFromNow(Function f, std::chrono::milliseconds delta)
51+
{
52+
schedule(std::move(f), std::chrono::system_clock::now() + delta);
53+
}
5154

52-
// Another convenience method: call f approximately
53-
// every deltaMilliSeconds forever, starting deltaMilliSeconds from now.
54-
// To be more precise: every time f is finished, it
55-
// is rescheduled to run deltaMilliSeconds later. If you
56-
// need more accurate scheduling, don't use this method.
57-
void scheduleEvery(Function f, int64_t deltaMilliSeconds);
55+
/**
56+
* Repeat f until the scheduler is stopped. First run is after delta has passed once.
57+
*
58+
* The timing is not exact: Every time f is finished, it is rescheduled to run again after delta. If you need more
59+
* accurate scheduling, don't use this method.
60+
*/
61+
void scheduleEvery(Function f, std::chrono::milliseconds delta);
5862

5963
/**
6064
* Mock the scheduler to fast forward in time.

‎src/test/scheduler_tests.cpp‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -150,10 +150,10 @@ BOOST_AUTO_TEST_CASE(mockforward)
150150
CScheduler::Function dummy = [&counter]{counter++;};
151151

152152
// schedule jobs for 2, 5 & 8 minutes into the future
153-
int64_t min_in_milli = 60*1000;
154-
scheduler.scheduleFromNow(dummy, 2*min_in_milli);
155-
scheduler.scheduleFromNow(dummy, 5*min_in_milli);
156-
scheduler.scheduleFromNow(dummy, 8*min_in_milli);
153+
154+
scheduler.scheduleFromNow(dummy, std::chrono::minutes{2});
155+
scheduler.scheduleFromNow(dummy, std::chrono::minutes{5});
156+
scheduler.scheduleFromNow(dummy, std::chrono::minutes{8});
157157

158158
// check taskQueue
159159
std::chrono::system_clock::time_point first, last;
@@ -163,10 +163,10 @@ BOOST_AUTO_TEST_CASE(mockforward)
163163
std::thread scheduler_thread([&]() { scheduler.serviceQueue(); });
164164

165165
// bump the scheduler forward 5 minutes
166-
scheduler.MockForward(std::chrono::seconds(5*60));
166+
scheduler.MockForward(std::chrono::minutes{5});
167167

168168
// ensure scheduler has chance to process all tasks queued for before 1 ms from now.
169-
scheduler.scheduleFromNow([&scheduler]{ scheduler.stop(false); }, 1);
169+
scheduler.scheduleFromNow([&scheduler] { scheduler.stop(false); }, std::chrono::milliseconds{1});
170170
scheduler_thread.join();
171171

172172
// check that the queue only has one job remaining

‎src/wallet/load.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ void StartWallets(CScheduler& scheduler)
8888
}
8989

9090
// Schedule periodic wallet flushes and tx rebroadcasts
91-
scheduler.scheduleEvery(MaybeCompactWalletDB, 500);
92-
scheduler.scheduleEvery(MaybeResendWalletTxs, 1000);
91+
scheduler.scheduleEvery(MaybeCompactWalletDB, std::chrono::milliseconds{500});
92+
scheduler.scheduleEvery(MaybeResendWalletTxs, std::chrono::milliseconds{1000});
9393
}
9494

9595
void FlushWallets()

0 commit comments

Comments
 (0)