Add extra comments for various start/end handlers
Hopefully this helps to provide some clarity for people about when to
use the LogReader vs. NodeEventLoopFactory startup handlers.
Change-Id: Ice8501f4c4da3d111cffcfa16298f7099e847caa
Signed-off-by: James Kuszmaul <jabukuszmaul+collab@gmail.com>
diff --git a/aos/events/simulated_event_loop.h b/aos/events/simulated_event_loop.h
index c4704ff..8242d6c 100644
--- a/aos/events/simulated_event_loop.h
+++ b/aos/events/simulated_event_loop.h
@@ -220,8 +220,10 @@
// Starts the node up by calling the OnStartup handlers. These get called
// every time a node is started.
- // Called when a node has started. This is typically when a log file starts
- // for a node.
+ // Called when a node has started. This will most commonly be at the monotonic
+ // clock epoch. In log replay, this will occur prior to any messages
+ // (including "fetched" messages) being replayed for that node.
+ // Called on every boot.
void OnStartup(std::function<void()> &&fn);
// Called when a node shuts down. These get called every time a node is shut