From 3931af3b805877315630fbe6058412754a4912de Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Mon, 7 Aug 2017 16:11:34 +0100 Subject: [PATCH] Comment on the purpose of the latestEventsUpdater --- .../matrix-org/dendrite/roomserver/input/latest_events.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/github.com/matrix-org/dendrite/roomserver/input/latest_events.go b/src/github.com/matrix-org/dendrite/roomserver/input/latest_events.go index c1e90cf62..9f530424f 100644 --- a/src/github.com/matrix-org/dendrite/roomserver/input/latest_events.go +++ b/src/github.com/matrix-org/dendrite/roomserver/input/latest_events.go @@ -73,6 +73,10 @@ func updateLatestEvents( return u.doUpdateLatestEvents() } +// latestEventsUpdater tracks the state used to update the latest events in the +// room. It mostly just ferries state between the various function calls. +// The state could be passed using function arguments, but it becomes impractical +// when there are so many variables to pass around. type latestEventsUpdater struct { db RoomEventDatabase updater types.RoomRecentEventsUpdater