Skip to content

Interface: RoomRelayBackend

Defined in: index.ts:124

Methods

counts()

counts(): object

Defined in: index.ts:132

Live connection counts (for info routes + tests).

Returns

object

clients

clients: number

hosts

hosts: number


dispose()

dispose(): void

Defined in: index.ts:134

Close every connection and stop the heartbeat.

Returns

void


handleHttp()

handleHttp(req, res): boolean

Defined in: index.ts:126

Handle an HTTP request for a relay route. Returns true if handled.

Parameters

req

IncomingMessage

res

ServerResponse

Returns

boolean


handleUpgrade()

handleUpgrade(req, socket, head): boolean

Defined in: index.ts:128

Handle a websocket upgrade for <prefix>/host or <prefix>/client.

Parameters

req

IncomingMessage

socket

Duplex

Buffer

Returns

boolean


sessions()

sessions(): RoomSessionInfo[]

Defined in: index.ts:130

The currently connectable hosts.

Returns

RoomSessionInfo[]