Documentation / @super-line/core / PresenceStore

Interface: PresenceStore

Defined in: packages/core/src/adapter.ts:64

Cluster-wide presence directory: a query/addressbook layer kept in the shared substrate (in-memory bus or Redis). Live message delivery does NOT read this — it exists only to answer srv.cluster.* / srv.isOnline.

Methods

addRoom()

addRoom(connId, room): void | Promise<void>

Defined in: packages/core/src/adapter.ts:74

Add a room to a connection's membership.

Parameters

connId

string

room

string

Returns

void | Promise<void>

---

beat()

beat(nodeId): void | Promise<void>

Defined in: packages/core/src/adapter.ts:70

Refresh this node's liveness (heartbeat).

Parameters

nodeId

string

Returns

void | Promise<void>

---

byUser()

byUser(userId): ConnDescriptor[] | Promise<ConnDescriptor[]>

Defined in: packages/core/src/adapter.ts:82

Descriptors for a given user key.

Parameters

userId

string

Returns

ConnDescriptor[] | Promise<ConnDescriptor[]>

---

clearNode()

clearNode(nodeId): void | Promise<void>

Defined in: packages/core/src/adapter.ts:72

Remove all of a node's connections + liveness (graceful shutdown cleanup).

Parameters

nodeId

string

Returns

void | Promise<void>

---

count()

count(): number | Promise<number>

Defined in: packages/core/src/adapter.ts:86

Total live connection count across the cluster.

Returns

number | Promise<number>

---

del()

del(connId): void | Promise<void>

Defined in: packages/core/src/adapter.ts:68

Remove a connection's descriptor.

Parameters

connId

string

Returns

void | Promise<void>

---

get()

get(connId): ConnDescriptor | Promise<ConnDescriptor | undefined> | undefined

Defined in: packages/core/src/adapter.ts:80

One connection's descriptor, if present.

Parameters

connId

string

Returns

ConnDescriptor | Promise<ConnDescriptor | undefined> | undefined

---

list()

list(): ConnDescriptor[] | Promise<ConnDescriptor[]>

Defined in: packages/core/src/adapter.ts:78

All live connection descriptors across the cluster.

Returns

ConnDescriptor[] | Promise<ConnDescriptor[]>

---

removeRoom()

removeRoom(connId, room): void | Promise<void>

Defined in: packages/core/src/adapter.ts:76

Remove a room from a connection's membership.

Parameters

connId

string

room

string

Returns

void | Promise<void>

---

roomMembers()

roomMembers(room): ConnDescriptor[] | Promise<ConnDescriptor[]>

Defined in: packages/core/src/adapter.ts:84

Descriptors that are members of room.

Parameters

room

string

Returns

ConnDescriptor[] | Promise<ConnDescriptor[]>

---

set()

set(descriptor): void | Promise<void>

Defined in: packages/core/src/adapter.ts:66

Record (or replace) a connection's descriptor.

Parameters

descriptor

ConnDescriptor

Returns

void | Promise<void>

---

topology()

topology(): NodeStat[] | Promise<NodeStat[]>

Defined in: packages/core/src/adapter.ts:88

Per-node aggregates.

Returns

NodeStat[] | Promise<NodeStat[]>