ApiCoreInterfaces
Interface: Rendezvous
Defined in: packages/core/src/network/rendezvous.ts:80
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
connect | readonly | () => Promise<void> | Connects to every relay, succeeding if any of them answers | packages/core/src/network/rendezvous.ts:82 |
disconnect | readonly | () => void | - | packages/core/src/network/rendezvous.ts:83 |
isConnected | readonly | () => boolean | - | packages/core/src/network/rendezvous.ts:99 |
join | readonly | (room, relays?) => void | Enters a room on every relay, and on relays as well — joining again with a different list moves to it | packages/core/src/network/rendezvous.ts:85 |
leave | readonly | (room) => void | - | packages/core/src/network/rendezvous.ts:86 |
off | readonly | <K>(event, callback) => void | - | packages/core/src/network/rendezvous.ts:101 |
on | readonly | <K>(event, callback) => void | - | packages/core/src/network/rendezvous.ts:100 |
reconnect | readonly | () => void | Tries every relay that is waiting to reconnect, now | packages/core/src/network/rendezvous.ts:96 |
relays | readonly | () => readonly RelayStatus[] | Every relay in use and where its socket stands | packages/core/src/network/rendezvous.ts:98 |
requestIce | readonly | () => void | Asks the relays that can hand out TURN passwords for fresh ones; they arrive as an ice event | packages/core/src/network/rendezvous.ts:94 |
signal | readonly | (kind, to, payload, room, box?) => void | Sends an offer or answer to a peer in one room: an offer where its hello was heard, sealed to the box it said hello with; an answer where the offer came, sealed to the box the offer came with. | packages/core/src/network/rendezvous.ts:92 |