Class: RedisPresenceBroadcastManager

Defined in: index.ts:153

A broadcast manager that uses a Redis cluster as a message broker via Redis's pub/sub.

When a client connects it specifies the document id to listen to.

When presence state changes for a document all listeners for that document id are notified that there is an update.

Constructors

Constructor

new RedisPresenceBroadcastManager(config: RedisPresenceBroadcastManagerConfig): RedisPresenceBroadcastManager;

Defined in: index.ts:158

Parameters

config

RedisPresenceBroadcastManagerConfig

Returns

RedisPresenceBroadcastManager

Methods

broadcastIndicator()

broadcastIndicator(docId: string, indicator: PresenceIndicator): Promise<void>;

Defined in: index.ts:172

Parameters

docId

string

indicator

PresenceIndicator

Returns

Promise<void>

connect()

connect(): Promise<void>;

Defined in: index.ts:168

Returns

Promise<void>

listenForPresence()

listenForPresence(
   docId: string,
   excludeClientId: string,
refs: Record<string, string>): Promise<void>;

Defined in: index.ts:179

Parameters

docId

string

excludeClientId

string

refs

Record<string, string>

Returns

Promise<void>