ApiCoreType aliases
Type Alias: RendezvousEvents
type RendezvousEvents = object;Defined in: packages/core/src/network/rendezvous.ts:60
Properties
connected
connected: () => void;Defined in: packages/core/src/network/rendezvous.ts:74
Returns
void
disconnected
disconnected: () => void;Defined in: packages/core/src/network/rendezvous.ts:75
Returns
void
ice
ice: (servers, expiresAt) => void;Defined in: packages/core/src/network/rendezvous.ts:73
TURN servers relays offered, all of them, with the earliest time their passwords stop working
Parameters
| Parameter | Type |
|---|---|
servers | ReadonlyArray<RTCIceServer> |
expiresAt | number |
Returns
void
peer-joined
"peer-joined": (did, room) => void;Defined in: packages/core/src/network/rendezvous.ts:62
A peer said hello in a room: it is there now
Parameters
| Parameter | Type |
|---|---|
did | string |
room | string |
Returns
void
signal
signal: (message) => void;Defined in: packages/core/src/network/rendezvous.ts:65
An offer or answer from a peer, opened, with the room it came in and the box to answer to
Parameters
| Parameter | Type |
|---|---|
message | { box: string; from: string; payload: unknown; room: string; type: SignalKind; } |
message.box | string |
message.from | string |
message.payload | unknown |
message.room | string |
message.type | SignalKind |
Returns
void
status
status: (relays) => void;Defined in: packages/core/src/network/rendezvous.ts:77
A relay opened, closed or is waiting to try again; carries every relay
Parameters
| Parameter | Type |
|---|---|
relays | ReadonlyArray<RelayStatus> |
Returns
void