Class RoomManager

Index

Constructors

Methods

getOrCreate list peek setCounters stats sweepExpiredPrincipals sweepIdle unload unloadAll

Constructors

constructor

new RoomManager(options: RoomManagerOptions): RoomManager
Parameters
- options: RoomManagerOptions
Returns RoomManager

Methods

getOrCreate

getOrCreate(roomId: string): Promise<Room>
Parameters
- roomId: string
Returns Promise<Room>

list

list(): string[]

Returns string[]

peek

peek(roomId: string): Promise<Room> | undefined
The pending Room for a loaded room id, or undefined when not loaded. Unlike getOrCreate this never creates: admin actions (kick) target only rooms that actually exist.
Parameters
- roomId: string
Returns Promise<Room> | undefined

setCounters

setCounters(counters: RoomCounters): void
Inject counters used by Room.handleMessage to bump metric values. The manager forwards them to every newly-loaded room.
Parameters
- counters: RoomCounters
Returns void

stats

stats(): Promise<{ idleMs: number; peerCount: number; roomId: string }[]>

Snapshot of (roomId, peerCount) for diagnostics / tests.

Returns Promise<{ idleMs: number; peerCount: number; roomId: string }[]>

sweepExpiredPrincipals

sweepExpiredPrincipals(now?: number): Promise<number>
Across every loaded room; see principal-expiry.ts. Timer: server.ts.
Parameters
- Optionalnow: number
Returns Promise<number>

sweepIdle

sweepIdle(): Promise<string[]>

Unload any room with zero peers that has been idle longer than idleUnloadMs. The persistence layer holds the durable copy, so unloading is non-destructive — the room is rehydrated on next connect.

Returns Promise<string[]>

unload

unload(roomId: string): Promise<void>
Parameters
- roomId: string
Returns Promise<void>

unloadAll

unloadAll(): Promise<void>

Returns Promise<void>