reticulum-js
    Preparing search index...

    Class WebSocketClientInterface

    Reticulum interface that connects to a remote node over a WebSocket.

    Wraps a WebSocket into RNS streams. Each outbound Packet is serialized and sent as a single binary message; each inbound binary message is parsed back into a Packet. The underlying connection may either be dialed via WebSocketClientInterface.connect or adopted from an already-open socket (e.g. one accepted by a server).

    Hierarchy

    • Interface
      • WebSocketClientInterface
    Index
    _adoptedWebSocket: any
    _closed: boolean
    _loopPromise: Promise<void> | null
    _packetWriter: WritableStreamDefaultWriter<any> | null = null
    _readable: any
    _writable: any
    ifacSize: number
    name: string
    online: boolean
    socket: any = null

    The underlying WebSocket connection, when one has been opened or adopted. Typed loosely because the base Interface.socket is declared as a Node socket; we reuse the same field so the base send() helper can see it.

    url: string
    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Opens the WebSocket connection (or adopts the provided one) and starts the inbound loop.

      Returns Promise<void>

    • Tears down the WebSocket and marks the interface offline.

      Returns Promise<void>

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Sends bytes wrapped in KISS framing

      Parameters

      Returns Promise<void>