node-dmx
    Preparing search index...

    Type Alias RdmnetClientOptions

    Configuration for a RdmnetClient.

    type RdmnetClientOptions = {
        autoReconnect?: boolean;
        cid?: Buffer;
        heartbeatIntervalMs?: number;
        heartbeatVector?: number;
        host: string;
        localAddress?: string;
        maxBufferBytes?: number;
        port?: number;
        postConnectAuth?: (
            context: {
                authorizationError?: Error | string | null;
                authorized?: boolean;
                host: string;
                port: number;
                socket: Socket;
                transport: "tcp" | "tls";
            },
        ) => Promise<void>
        | void;
        reconnectDelayMs?: number;
        reconnectMaxDelayMs?: number;
        requestTimeoutMs?: number;
        requireTlsAuthorization?: boolean;
        tls?: Omit<TlsConnectionOptions, "host" | "port">;
        transport?: "tcp" | "tls";
    }
    Index

    Properties

    autoReconnect? cid? heartbeatIntervalMs? heartbeatVector? host localAddress? maxBufferBytes? port? postConnectAuth? reconnectDelayMs? reconnectMaxDelayMs? requestTimeoutMs? requireTlsAuthorization? tls? transport?

    Properties

    autoReconnect?: boolean

    Enable reconnect behavior after unexpected disconnects. Default: true.

    cid?: Buffer

    Optional fixed CID. Must be 16 bytes when provided.

    heartbeatIntervalMs?: number

    Interval for keepalive heartbeats in milliseconds.

    heartbeatVector?: number

    Root vector used for generic heartbeat packets while not broker-bound.

    host: string

    Broker hostname or IP address.

    localAddress?: string

    Optional local interface address to bind for outbound connections.

    maxBufferBytes?: number

    Maximum buffered stream bytes before framing-corruption protection triggers.

    port?: number

    Broker TCP/TLS port. Defaults to RDMNET_DEFAULT_PORT.

    postConnectAuth?: (
        context: {
            authorizationError?: Error | string | null;
            authorized?: boolean;
            host: string;
            port: number;
            socket: Socket;
            transport: "tcp" | "tls";
        },
    ) => Promise<void>
    | void

    Optional post-connect hook for environment-specific auth/profile checks. Throwing rejects connect().

    reconnectDelayMs?: number

    Initial reconnect backoff delay in milliseconds.

    reconnectMaxDelayMs?: number

    Maximum reconnect backoff delay in milliseconds.

    requestTimeoutMs?: number

    Default timeout for request/response operations.

    requireTlsAuthorization?: boolean

    Require successful TLS peer authorization before the client is considered connected. Defaults to true when transport is 'tls'.

    tls?: Omit<TlsConnectionOptions, "host" | "port">

    TLS options forwarded to Node's tls.connect() when transport is 'tls'. Use this for CA/certificate/key/cipher policy configuration.

    transport?: "tcp" | "tls"

    Transport mode. Use 'tls' for secure sockets. Defaults to 'tcp'.

    Settings

    Member Visibility

    On This Page

    Properties