Rename timer `Setup` function to `Schedule`
This patch was motivated by my desire to fix a typo in the function
name. The noun "setup" is 1 word. The verb "set up" is 2 words. All
other member functions are verbs, so this one should be a verb too.
That means that the function should be called `SetUp`. During the
discussion that resulted from the rename, James Kuszmaul pointed out
that "setting up" a timer can be confusing. It implies that you can
only "set up" a timer once. But the intent is to let users set up
timers as many times as they like. So we decided on renaming the
function to `Schedule`. That conveys the purpose and intent better.
I took this opportunity to fix some other typos involving the verb
"set up".
Signed-off-by: Philipp Schrader <philipp.schrader@gmail.com>
Change-Id: I2f557d1f946960af82711f248820d5e2d385a5d3
diff --git a/aos/util/clock_publisher.cc b/aos/util/clock_publisher.cc
index 93102f6..f8c731f 100644
--- a/aos/util/clock_publisher.cc
+++ b/aos/util/clock_publisher.cc
@@ -8,8 +8,8 @@
aos::TimerHandler *timer_handler =
event_loop->AddTimer([this]() { SendTimepoints(); });
event_loop->OnRun([timer_handler, event_loop]() {
- timer_handler->Setup(event_loop->context().monotonic_event_time,
- std::chrono::seconds(1));
+ timer_handler->Schedule(event_loop->context().monotonic_event_time,
+ std::chrono::seconds(1));
});
}
diff --git a/aos/util/foxglove_websocket_lib.cc b/aos/util/foxglove_websocket_lib.cc
index ab99400..fd2cfd4 100644
--- a/aos/util/foxglove_websocket_lib.cc
+++ b/aos/util/foxglove_websocket_lib.cc
@@ -154,7 +154,7 @@
});
event_loop_->OnRun([timer, this]() {
- timer->Setup(event_loop_->monotonic_now(), kPollPeriod);
+ timer->Schedule(event_loop_->monotonic_now(), kPollPeriod);
});
}
FoxgloveWebsocketServer::~FoxgloveWebsocketServer() { server_.stop(); }
diff --git a/aos/util/mcap_logger.cc b/aos/util/mcap_logger.cc
index 4fb727c..cdac928 100644
--- a/aos/util/mcap_logger.cc
+++ b/aos/util/mcap_logger.cc
@@ -122,7 +122,7 @@
canonical_channels_(canonical_channels),
compression_(compression),
configuration_channel_([]() {
- // Setup a fake Channel for providing the configuration in the MCAP
+ // Set up a fake Channel for providing the configuration in the MCAP
// file. This is included for convenience so that consumers of the MCAP
// file can actually dereference things like the channel indices in AOS
// timing reports.
diff --git a/aos/util/top.cc b/aos/util/top.cc
index 852bb79..a74b019 100644
--- a/aos/util/top.cc
+++ b/aos/util/top.cc
@@ -131,7 +131,7 @@
track_threads_(track_threads) {
TimerHandler *timer = event_loop_->AddTimer([this]() { UpdateReadings(); });
event_loop_->OnRun([timer, this]() {
- timer->Setup(event_loop_->monotonic_now(), kSamplePeriod);
+ timer->Schedule(event_loop_->monotonic_now(), kSamplePeriod);
});
}
diff --git a/aos/util/top_test.cc b/aos/util/top_test.cc
index 7d413a4..6888457 100644
--- a/aos/util/top_test.cc
+++ b/aos/util/top_test.cc
@@ -63,7 +63,7 @@
Top top(&event_loop_);
top.set_track_pids({pid});
event_loop_.AddTimer([this]() { event_loop_.Exit(); })
- ->Setup(event_loop_.monotonic_now() + std::chrono::seconds(2));
+ ->Schedule(event_loop_.monotonic_now() + std::chrono::seconds(2));
event_loop_.Run();
flatbuffers::FlatBufferBuilder fbb;
fbb.ForceDefaults(true);
@@ -111,7 +111,7 @@
Top top(&event_loop_);
top.set_track_top_processes(true);
event_loop_.AddTimer([this]() { event_loop_.Exit(); })
- ->Setup(event_loop_.monotonic_now() + std::chrono::seconds(2));
+ ->Schedule(event_loop_.monotonic_now() + std::chrono::seconds(2));
event_loop_.SkipTimingReport();
event_loop_.SkipAosLog();
event_loop_.Run();
@@ -155,7 +155,7 @@
Top top(&event_loop_);
top.set_track_top_processes(true);
event_loop_.AddTimer([this]() { event_loop_.Exit(); })
- ->Setup(event_loop_.monotonic_now() + std::chrono::seconds(2));
+ ->Schedule(event_loop_.monotonic_now() + std::chrono::seconds(2));
event_loop_.Run();
flatbuffers::FlatBufferBuilder fbb;
fbb.ForceDefaults(true);