types

Documentation

Overview

Package types provides the types that are used internally within the roomserver.

Index

• Constants
• type Event
• type EventNID
• type EventStateKeyNID
• type EventTypeNID
• type MissingEventError
  • func (e MissingEventError) Error() string
• type RoomInfo
• type RoomNID
• type StateAtEvent
  • func (s StateAtEvent) IsStateEvent() bool
• type StateAtEventAndReference
• type StateBlockNID
• type StateBlockNIDList
• type StateEntry
  • func DeduplicateStateEntries(a []StateEntry) []StateEntry
  • func (a StateEntry) LessThan(b StateEntry) bool
• type StateEntryList
• type StateKeyTuple
  • func (a StateKeyTuple) LessThan(b StateKeyTuple) bool
• type StateSnapshotNID

Constants

const (
	// MRoomCreateNID is the numeric ID for the "m.room.create" event type.
	MRoomCreateNID = 1
	// MRoomPowerLevelsNID is the numeric ID for the "m.room.power_levels" event type.
	MRoomPowerLevelsNID = 2
	// MRoomJoinRulesNID is the numeric ID for the "m.room.join_rules" event type.
	MRoomJoinRulesNID = 3
	// MRoomThirdPartyInviteNID is the numeric ID for the "m.room.third_party_invite" event type.
	MRoomThirdPartyInviteNID = 4
	// MRoomMemberNID is the numeric ID for the "m.room.member" event type.
	MRoomMemberNID = 5
	// MRoomRedactionNID is the numeric ID for the "m.room.redaction" event type.
	MRoomRedactionNID = 6
	// MRoomHistoryVisibilityNID is the numeric ID for the "m.room.history_visibility" event type.
	MRoomHistoryVisibilityNID = 7
)

const (
	// EmptyStateKeyNID is the numeric ID for the empty state key.
	EmptyStateKeyNID = 1
)

Types

type Event

type Event struct {
	EventNID EventNID
	gomatrixserverlib.Event
}

An Event is a gomatrixserverlib.Event with the numeric event ID attached. It is when performing bulk event lookup in the database.

type EventNID

type EventNID int64

EventNID is a numeric ID for an event.

type EventStateKeyNID

type EventStateKeyNID int64

EventStateKeyNID is a numeric ID for an event state_key.

type EventTypeNID

type EventTypeNID int64

EventTypeNID is a numeric ID for an event type.

type MissingEventError

type MissingEventError string

A MissingEventError is an error that happened because the roomserver was missing requested events from its database.

func (MissingEventError) Error

func (e MissingEventError) Error() string

type RoomInfo

type RoomInfo struct {
	RoomNID          RoomNID
	RoomVersion      gomatrixserverlib.RoomVersion
	StateSnapshotNID StateSnapshotNID
	IsStub           bool
}

RoomInfo contains metadata about a room

type RoomNID

type RoomNID int64

RoomNID is a numeric ID for a room.

type StateAtEvent

type StateAtEvent struct {
	// Should this state overwrite the latest events and memberships of the room?
	// This might be necessary when rejoining a federated room after a period of
	// absence, as our state and latest events will be out of date.
	Overwrite bool
	// The state before the event.
	BeforeStateSnapshotNID StateSnapshotNID
	// True if this StateEntry is rejected. State resolution should then treat this
	// StateEntry as being a message event (not a state event).
	IsRejected bool
	// The state entry for the event itself, allows us to calculate the state after the event.
	StateEntry
}

StateAtEvent is the state before and after a matrix event.

func (StateAtEvent) IsStateEvent

func (s StateAtEvent) IsStateEvent() bool

IsStateEvent returns whether the event the state is at is a state event.

type StateAtEventAndReference

type StateAtEventAndReference struct {
	StateAtEvent
	gomatrixserverlib.EventReference
}

StateAtEventAndReference is StateAtEvent and gomatrixserverlib.EventReference glued together. It is used when looking up the latest events in a room in the database. The gomatrixserverlib.EventReference is used to check whether a new event references the event. The StateAtEvent is used to construct the current state of the room from the latest events.

type StateBlockNID

type StateBlockNID int64

StateBlockNID is a numeric ID for a block of state data. These blocks of state data are combined to form the actual state.

type StateBlockNIDList

type StateBlockNIDList struct {
	StateSnapshotNID StateSnapshotNID
	StateBlockNIDs   []StateBlockNID
}

StateBlockNIDList is used to return the result of bulk StateBlockNID lookups from the database.

type StateEntry

type StateEntry struct {
	StateKeyTuple
	// The numeric ID for the event.
	EventNID EventNID
}

A StateEntry is an entry in the room state of a matrix room.

func DeduplicateStateEntries

func DeduplicateStateEntries(a []StateEntry) []StateEntry

Deduplicate takes a set of state entries and ensures that there are no duplicate (event type, state key) tuples. If there are then we dedupe them, making sure that the latest/highest NIDs are always chosen.

func (StateEntry) LessThan

func (a StateEntry) LessThan(b StateEntry) bool

LessThan returns true if this state entry is less than the other state entry. The ordering is arbitrary and is used to implement binary search and to efficiently deduplicate entries.

type StateEntryList

type StateEntryList struct {
	StateBlockNID StateBlockNID
	StateEntries  []StateEntry
}

StateEntryList is used to return the result of bulk state entry lookups from the database.

type StateKeyTuple

type StateKeyTuple struct {
	// The numeric ID for the event type.
	EventTypeNID EventTypeNID
	// The numeric ID for the state key.
	EventStateKeyNID EventStateKeyNID
}

A StateKeyTuple is a pair of a numeric event type and a numeric state key. It is used to lookup state entries.

func (StateKeyTuple) LessThan

func (a StateKeyTuple) LessThan(b StateKeyTuple) bool

LessThan returns true if this state key is less than the other state key. The ordering is arbitrary and is used to implement binary search and to efficiently deduplicate entries.

type StateSnapshotNID

type StateSnapshotNID int64

StateSnapshotNID is a numeric ID for the state at an event.