Comment on what the RoomRecentEventsUpdater is doing

This commit is contained in:
Mark Haines 2017-02-21 12:40:06 +00:00
parent 0f4787efeb
commit bb38ef4433

View file

@ -127,6 +127,8 @@ type StateEntryList struct {
} }
// A RoomRecentEventsUpdater is used to update the recent events in a room. // A RoomRecentEventsUpdater is used to update the recent events in a room.
// (On postgresql this wraps a database transaction that holds a "FOR UPDATE"
// lock on the a row holding the latest events for the room.)
type RoomRecentEventsUpdater interface { type RoomRecentEventsUpdater interface {
// Store the previous events referenced by an event. // Store the previous events referenced by an event.
StorePreviousEvents(eventNID EventNID, previousEventReferences []gomatrixserverlib.EventReference) error StorePreviousEvents(eventNID EventNID, previousEventReferences []gomatrixserverlib.EventReference) error