From ade7b00e6eb76d1d9ecbb7bff716169acbcc5e1d Mon Sep 17 00:00:00 2001 From: Neil Alexander Date: Mon, 19 Oct 2020 14:58:36 +0100 Subject: [PATCH] Update comments --- roomserver/api/output.go | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/roomserver/api/output.go b/roomserver/api/output.go index 53f4decc0..9cb814a47 100644 --- a/roomserver/api/output.go +++ b/roomserver/api/output.go @@ -183,8 +183,14 @@ func (ore *OutputNewRoomEvent) AddsState() []gomatrixserverlib.HeaderedEvent { } // An OutputOldRoomEvent is written when the roomserver receives an old event. +// This will typically happen as a result of getting either missing events +// or backfilling. Downstream components may wish to send these events to +// clients when it is advantageous to do so, but with the consideration that +// the event is likely a historic event. +// // Old events do not update forward extremities or the current room state, -// therefore they must not be treated as if they do. +// therefore they must not be treated as if they do. Downstream components +// should build their current room state up from OutputNewRoomEvents only. type OutputOldRoomEvent struct { // The Event. Event gomatrixserverlib.HeaderedEvent `json:"event"`