Documentation / @super-line/server / ClusterView

Interface: ClusterView

Defined in: index.ts:237

Asynchronous, cluster-wide introspection backed by the adapter's presence directory. Methods reject if the configured adapter has no presence support.

Methods

byUser()

byUser(userId): Promise<ConnDescriptor[]>

Defined in: index.ts:243

Connections for a given user key (the identify hook).

Parameters

userId

string

Returns

Promise<ConnDescriptor[]>

---

connections()

connections(): Promise<ConnDescriptor[]>

Defined in: index.ts:239

Every live connection across the cluster.

Returns

Promise<ConnDescriptor[]>

---

count()

count(): Promise<number>

Defined in: index.ts:241

Total live connection count across the cluster.

Returns

Promise<number>

---

room()

room(name): Promise<ConnDescriptor[]>

Defined in: index.ts:245

Connections that are members of room, across nodes.

Parameters

name

string

Returns

Promise<ConnDescriptor[]>

---

topology()

topology(): Promise<NodeStat[]>

Defined in: index.ts:247

Per-node aggregates (the other nodes and their counts).

Returns

Promise<NodeStat[]>