Class MemoryConnectionStore

In-process connection store: connections and their channel memberships in Maps.

The zero-config default and the building block a WS adapter uses on a single node (swap for a Redis/DynamoDB store to share presence across instances).

Implements

ConnectionStore

Index

Constructors

Methods

add connectionsFor members remove subscribe unsubscribe create

Constructors

constructor

new MemoryConnectionStore(): MemoryConnectionStore

Returns MemoryConnectionStore

Methods

add

add(connection: Connection): Promise<void>
Parameters
- connection: Connection
Returns Promise<void>

Inherit Doc

Implementation of ConnectionStore.add

connectionsFor

connectionsFor(channel: string): Promise<Connection<unknown>[]>
Parameters
- channel: string
Returns Promise<Connection<unknown>[]>

Inherit Doc

Implementation of ConnectionStore.connectionsFor

members

members(channel: string): Promise<PresenceMember<unknown>[]>
Parameters
- channel: string
Returns Promise<PresenceMember<unknown>[]>

Inherit Doc

Implementation of ConnectionStore.members

remove

remove(connectionId: string): Promise<void>
Parameters
- connectionId: string
Returns Promise<void>

Inherit Doc

Implementation of ConnectionStore.remove

subscribe(connectionId: string, channel: string): Promise<void>
Parameters
- connectionId: string
- channel: string
Returns Promise<void>

Inherit Doc

Implementation of ConnectionStore.subscribe

unsubscribe

unsubscribe(connectionId: string, channel: string): Promise<void>
Parameters
- connectionId: string
- channel: string
Returns Promise<void>

Inherit Doc

Implementation of ConnectionStore.unsubscribe

`Static`create

create(): MemoryConnectionStore

Create a memory connection store.

Returns MemoryConnectionStore
A new store.