Interface SignallingTransport

Identity-aware control channel used to negotiate WebRTC peers.

A transport routes SDP, ICE, and structured failures; it does not carry A11 action or node data. WebRtcWireStream installs its message callback and uses the resulting peer connection as the data path.

interface SignallingTransport {
    close(): Status;
    getIdentity(): string;
    getImpl?(): unknown;
    getStatus(): Status;
    isConnected(): boolean;
    send(message: SignallingMessage): Status;
    setOnMessage(onMessage: OnSignallingMessage): Status;
}

Implemented by

WebSocketSignallingClient

Index

Methods

close getIdentity getImpl? getStatus isConnected send setOnMessage

Methods

close

close(): Status
End signalling and release its network resources.

Returns Status
- Defined in src/signalling.ts:308

getIdentity

getIdentity(): string
Return the local routing identity.

Returns string
- Defined in src/signalling.ts:310

`Optional`getImpl

getImpl?(): unknown
Expose the implementation-specific channel, when available.

Returns unknown
- Defined in src/signalling.ts:316

getStatus

getStatus(): Status
Return current or terminal status; an explicit close may be CANCELLED.

Returns Status
- Defined in src/signalling.ts:314

isConnected

isConnected(): boolean
Return whether messages can currently be exchanged.

Returns boolean
- Defined in src/signalling.ts:312

send

send(message: SignallingMessage): Status
Route one control message to its recipient.
Parameters
- message: SignallingMessage
Returns Status
- Defined in src/signalling.ts:304

setOnMessage

setOnMessage(onMessage: OnSignallingMessage): Status
Replace the callback that consumes inbound negotiation messages.
Parameters
- onMessage: OnSignallingMessage
Returns Status
- Defined in src/signalling.ts:306