reticulum-js
    Preparing search index...

    Class WebSocketServerInterface

    Reticulum interface that listens for inbound WebSocket connections.

    Each accepted connection would be exposed as a spawned WebSocketClientInterface via the connection event, mirroring the Python reference WebSocketServerInterface.

    The server side is not yet implemented. This class reserves the intended API shape; connect() will throw until it is built.

    Hierarchy

    • Interface
      • WebSocketServerInterface
    Index
    _packetWriter: WritableStreamDefaultWriter<any> | null = null
    ifacSize: number
    listenIp: string
    listenPort: number
    name: string
    online: boolean
    server: any
    socket: Socket | null = null

    The underlying socket, when this interface is backed by a Node.js stream.

    spawnedInterfaces: Set<WebSocketClientInterface>
    • 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

    • Starts listening for inbound WebSocket connections.

      Returns Promise<void>

      Not yet implemented.

    • Closes the listening server and disconnects all spawned client interfaces.

      Returns Promise<void>

      Not yet implemented.

    • 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>