Interface: RelayServer
@roomful/relay / RelayServer
Interface: RelayServer
Section titled “Interface: RelayServer”Defined in: packages/relay/src/server.ts:72
Exposes the public relay server API.
Properties
Section titled “Properties”
readonlyport:number
Defined in: packages/relay/src/server.ts:76
Reports the configured listening port.
Methods
Section titled “Methods”auth()
Section titled “auth()”auth(
handler):RelayServer
Defined in: packages/relay/src/server.ts:84
Registers a token-based auth handler.
Parameters
Section titled “Parameters”handler
Section titled “handler”The auth handler invoked for token-bearing join requests.
Returns
Section titled “Returns”RelayServer
The relay server for chaining.
getAddress()
Section titled “getAddress()”getAddress():
string
Defined in: packages/relay/src/server.ts:105
Returns the base HTTP address for the running server.
Returns
Section titled “Returns”string
The server address.
start()
Section titled “start()”start():
Promise<void>
Defined in: packages/relay/src/server.ts:91
Starts listening for relay traffic.
Returns
Section titled “Returns”Promise<void>
A promise that resolves when the server starts listening.
stop()
Section titled “stop()”stop():
Promise<void>
Defined in: packages/relay/src/server.ts:98
Stops the relay server and closes active connections.
Returns
Section titled “Returns”Promise<void>
A promise that resolves when shutdown completes.