mirror of
https://github.com/1f349/dendrite.git
synced 2024-09-20 02:46:34 +01:00
34 lines
1.3 KiB
Go
34 lines
1.3 KiB
Go
package caching
|
|
|
|
import (
|
|
"github.com/matrix-org/dendrite/roomserver/types"
|
|
)
|
|
|
|
// WARNING: This cache is mutable because it's entirely possible that
|
|
// the IsStub or StateSnaphotNID fields can change, even though the
|
|
// room version and room NID fields will not. This is only safe because
|
|
// the RoomInfoCache is used ONLY within the roomserver and because it
|
|
// will be kept up-to-date by the latest events updater. It MUST NOT be
|
|
// used from other components as we currently have no way to invalidate
|
|
// the cache in downstream components.
|
|
|
|
// RoomInfosCache contains the subset of functions needed for
|
|
// a room Info cache. It must only be used from the roomserver only
|
|
// It is not safe for use from other components.
|
|
type RoomInfoCache interface {
|
|
GetRoomInfo(roomID string) (roomInfo *types.RoomInfo, ok bool)
|
|
StoreRoomInfo(roomID string, roomInfo *types.RoomInfo)
|
|
}
|
|
|
|
// GetRoomInfo must only be called from the roomserver only. It is not
|
|
// safe for use from other components.
|
|
func (c Caches) GetRoomInfo(roomID string) (*types.RoomInfo, bool) {
|
|
return c.RoomInfos.Get(roomID)
|
|
}
|
|
|
|
// StoreRoomInfo must only be called from the roomserver only. It is not
|
|
// safe for use from other components.
|
|
func (c Caches) StoreRoomInfo(roomID string, roomInfo *types.RoomInfo) {
|
|
c.RoomInfos.Set(roomID, roomInfo)
|
|
}
|