ws-asyncapi API / core / Backplane

Interface: Backplane

Defined in: .api-entries/core/index.d.ts:314

Properties

nodeId

readonly nodeId: string

Defined in: .api-entries/core/index.d.ts:316

unique id of this server node

Methods

publish()

publish(topic, payload, offset?, except?): Promise<void>

Defined in: .api-entries/core/index.d.ts:322

Fan a message out to all nodes; each delivers locally to subscribers. When offset is supplied (recovery-capable backplanes) the message is also appended to the replay log under that offset.

Parameters

topic

string

payload

string | Uint8Array<ArrayBufferLike>

offset?

string | number

except?

string[]

Returns

Promise<void>

---

onMessage()

onMessage(handler): void

Defined in: .api-entries/core/index.d.ts:324

Register the local delivery callback (called once by the adapter).

Parameters

handler

(message) => void

Returns

void

---

addToRoom()

addToRoom(topic, socketId): Promise<void>

Defined in: .api-entries/core/index.d.ts:326

Record that a local socket joined a room (topic).

Parameters

topic

string

socketId

string

Returns

Promise<void>

---

removeFromRoom()

removeFromRoom(topic, socketId): Promise<void>

Defined in: .api-entries/core/index.d.ts:328

Record that a local socket left a room (topic).

Parameters

topic

string

socketId

string

Returns

Promise<void>

---

removeSocket()

removeSocket(socketId): Promise<void>

Defined in: .api-entries/core/index.d.ts:330

Remove a socket from all rooms (on disconnect).

Parameters

socketId

string

Returns

Promise<void>

---

roomMembers()

roomMembers(topic): Promise<string[]>

Defined in: .api-entries/core/index.d.ts:332

Cluster-wide socket ids in a room (presence / fetchSockets).

Parameters

topic

string

Returns

Promise<string[]>

---

rooms()

rooms(socketId): Promise<string[]>

Defined in: .api-entries/core/index.d.ts:334

Rooms a socket currently belongs to.

Parameters

socketId

string

Returns

Promise<string[]>

---

assignOffset()?

optional assignOffset(): MaybePromise<string | number>

Defined in: .api-entries/core/index.d.ts:336

Vend the next monotonic, cluster-wide offset for an outgoing event.

Returns

MaybePromise<string | number>

---

replaySince()?

optional replaySince(offset, topics): Promise<BackplaneMessage[]>

Defined in: .api-entries/core/index.d.ts:341

Replay buffered events for the given topics whose offset is strictly greater than offset, in global publish order.

Parameters

offset

string | number

topics

string[]

Returns

Promise<BackplaneMessage[]>

---

setPresence()?

optional setPresence(room, socketId, state): Promise<void>

Defined in: .api-entries/core/index.d.ts:343

Store (or replace) a member's presence state in a room.

Parameters

room

string

socketId

string

state

unknown

Returns

Promise<void>

---

clearPresence()?

optional clearPresence(room, socketId): Promise<void>

Defined in: .api-entries/core/index.d.ts:345

Remove a member from a room's presence roster.

Parameters

room

string

socketId

string

Returns

Promise<void>

---

getPresence()?

optional getPresence(room): Promise<Record<string, unknown>>

Defined in: .api-entries/core/index.d.ts:347

Current roster of a presence room: socket id → state.

Parameters

room

string

Returns

Promise<Record<string, unknown>>

---

configureHistory()?

optional configureHistory(events): void

Defined in: .api-entries/core/index.d.ts:349

Register which event names to retain and how many (event name → keep).

Parameters

events

Record<string, number>

Returns

void

---

appendHistory()?

optional appendHistory(topic, event, data): Promise<void>

Defined in: .api-entries/core/index.d.ts:351

Append an event to a room's history (no-op if the event isn't retained).

Parameters

topic

string

event

string

data

unknown

Returns

Promise<void>

---

getHistory()?

optional getHistory(topic, limit?): Promise<object[]>

Defined in: .api-entries/core/index.d.ts:353

Fetch a room's retained events (most-recent limit, or all), in order.

Parameters

topic

string

limit?

number

Returns

Promise<object[]>

---

saveSession()?

optional saveSession(sessionId, state): Promise<void>

Defined in: .api-entries/core/index.d.ts:358

Persist a disconnecting connection's recoverable state for ttlMs.

Parameters

sessionId

string

state

SessionState

Returns

Promise<void>

---

loadSession()?

optional loadSession(sessionId): Promise<SessionState>

Defined in: .api-entries/core/index.d.ts:360

Load a reconnecting connection's state, or null if expired/unknown.

Parameters

sessionId

string

Returns

Promise<SessionState>

---

dropSession()?

optional dropSession(sessionId): Promise<void>

Defined in: .api-entries/core/index.d.ts:362

Drop a session once it has been recovered (or on hard close).

Parameters

sessionId

string

Returns

Promise<void>

---

close()

close(): Promise<void>

Defined in: .api-entries/core/index.d.ts:363

Returns

Promise<void>