reticulum-js
    Preparing search index...

    Interface WebSocketServerInterfaceOptions

    interface WebSocketServerInterfaceOptions {
        certFile?: string;
        framing?: "raw" | "kiss";
        ifacSize?: number;
        keyFile?: string;
        listenIp?: string;
        listenPort?: number;
        name?: string;
        networkName?: string;
        passphrase?: string;
        ssl?: boolean;
    }
    Index
    certFile? framing? ifacSize? keyFile? listenIp? listenPort? name? networkName? passphrase? ssl?
    certFile?: string

    Path to a PEM certificate chain, required when ssl is set (mirrors the Python reference certfile config key).

    framing?: "raw" | "kiss"

    Wire framing inherited by spawned client interfaces. Default "raw".

    ifacSize?: number

    Optional IFAC field size for spawned clients.

    keyFile?: string

    Path to a PEM private key, required when ssl is set (mirrors the Python reference keyfile config key).

    listenIp?: string

    Address to bind the server to. Default 0.0.0.0.

    listenPort?: number

    Port to bind the server to.

    name?: string

    Interface name.

    networkName?: string

    Shared IFAC network name (ifac_netname).

    passphrase?: string

    Shared IFAC passphrase (ifac_netkey).

    ssl?: boolean

    Terminate TLS so clients connect over wss:// (mirrors the Python reference ssl config key). Requires both certFile and keyFile. Browsers in a secure context (HTTPS) cannot open ws://, so a browser-facing server needs this. Default false.

    Settings
    Member Visibility

    On This Page
    Properties