mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-11 17:03:10 -06:00
Code Issues Packages Projects Releases Wiki Activity

More comments

Browse source
This commit is contained in:
Mark Haines 2017-06-27 12:07:22 +01:00
parent 991dfc8ef4
commit 4f930d2a26
1 changed files with 19 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
src/github.com/matrix-org/dendrite/roomserver/api/output.go
View file

@ -19,6 +19,14 @@ import (
) )
// An OutputRoomEvent is written when the roomserver receives a new event. // An OutputRoomEvent is written when the roomserver receives a new event.
// It contains the full matrix room event and enough information for a
// consumer to construct the current state of the room and the state before the
// event.
//
// When we talk about state in a matrix room we are talking about the state
// after a list of events. The current state is the state after the latest
// event IDs in the room. The state before an event is the state after its
// prev_events.
type OutputRoomEvent struct { type OutputRoomEvent struct {
// The JSON bytes of the event. // The JSON bytes of the event.
Event []byte Event []byte
@ -37,13 +45,23 @@ type OutputRoomEvent struct {
// This is used by consumers to check if they can safely update their // This is used by consumers to check if they can safely update their
// current state using the delta supplied in AddsStateEventIDs and // current state using the delta supplied in AddsStateEventIDs and
// RemovesStateEventIDs. // RemovesStateEventIDs.
//
// If the LastSentEventID doesn't match what they were expecting it to be // If the LastSentEventID doesn't match what they were expecting it to be
// they can use the LatestEventIDs to request the full current state. // they can use the LatestEventIDs to request the full current state.
LastSentEventID string LastSentEventID string
// The state event IDs that are part of the state at the event, but not // The state event IDs that are part of the state at the event, but not
// part of the current state. Together with the StateBeforeRemovesEventIDs // part of the current state. Together with the StateBeforeRemovesEventIDs
// this can be used to construct the state before the event from the // this can be used to construct the state before the event from the
// current state. // current state. The StateBeforeAddsEventIDs and StateBeforeRemovesEventIDs
// delta is applied after the AddsStateEventIDs and RemovesStateEventIDs.
//
// Consumers need to know the state at each event in order to determine
// which users and servers are allowed to see the event. This information
// is needed to apply the history visibility rules and to tell which
// servers we need to push events to over federation.
//
// The state is given as a delta against the current state because they are
// usually either the same state, or differ by just a couple of events.
StateBeforeAddsEventIDs []string StateBeforeAddsEventIDs []string
// The state event IDs that are part of the current state, but not part // The state event IDs that are part of the current state, but not part
// of the state at the event. // of the state at the event.