Documentation / @imvu/client / RealtimeCoordinator

Class: RealtimeCoordinator

Defined in: packages/client/src/client/RealtimeCoordinator.ts:48

Bridges REST update targets to reference-counted IMQ invalidations and raw mount subscriptions.

Constructors

Constructor

new RealtimeCoordinator(client, createManager?): RealtimeCoordinator;

Defined in: packages/client/src/client/RealtimeCoordinator.ts:55

Parameters

Parameter	Type
client	Client
createManager?	RealtimeManagerFactory

Returns

RealtimeCoordinator

Methods

close()

close(): void;

Defined in: packages/client/src/client/RealtimeCoordinator.ts:116

Returns

void

---

listen()

listen(
   queue, 
   mount, 
   listener
): Promise<RealtimeSubscription>;

Defined in: packages/client/src/client/RealtimeCoordinator.ts:79

Subscribe to every message on a mount, sharing the IMQ subscription with any watches of the same target. Connects IMQ on first use.

Parameters

Parameter	Type
queue	string
mount	string
listener	MessageListener

Returns

Promise<RealtimeSubscription>

---

onReconnect()

onReconnect(listener): () => void;

Defined in: packages/client/src/client/RealtimeCoordinator.ts:111

Run listener after each IMQ reconnect (not the first connect). Subscriptions are restored automatically, but anything delivered while disconnected was missed, so this is the cue to resynchronize from REST. Returns an unsubscribe function.

Parameters

Parameter	Type
listener	() => void

Returns

() => void

---

send()

send(
   queue, 
   mount, 
   message
): Promise<void>;

Defined in: packages/client/src/client/RealtimeCoordinator.ts:96

Send a message on a mount; resolves once the gateway acknowledges it.

Parameters

Parameter	Type
queue	string
mount	string
message	unknown

Returns

Promise<void>

---

watch()

watch<T>(document): Promise<DocumentWatch<T>>;

Defined in: packages/client/src/client/RealtimeCoordinator.ts:60

Type Parameters

Type Parameter
T extends RemoteDocument

Parameters

Parameter	Type
document	T

Returns

Promise<DocumentWatch<T>>