ocpp-rpc
    Preparing search index...

    Interface RPCServerOptions

    interface RPCServerOptions {
        callConcurrency?: number;
        callTimeoutMs?: number;
        deferPingsOnActivity?: boolean;
        maxBadMessages?: number;
        pingIntervalMs?: number;
        protocols?: string[];
        respondWithDetailedErrors?: boolean;
        strictMode?: boolean | string[];
        strictModeValidators?: Validator[];
        wssOptions?: ServerOptions<typeof WebSocket, typeof IncomingMessage>;
    }
    Index
    callConcurrency? callTimeoutMs? deferPingsOnActivity? maxBadMessages? pingIntervalMs? protocols? respondWithDetailedErrors? strictMode? strictModeValidators? wssOptions?
    callConcurrency?: number

    The number of concurrent in-flight outbound calls permitted at any one time. Additional calls are queued. There is no concurrency limit imposed on inbound calls. OCPP requires this to be set to 1, but you may choose other values for non-OCPP/custom protocols.

    1

    callTimeoutMs?: number

    Milliseconds to wait before unanswered outbound calls are rejected automatically.

    30000

    deferPingsOnActivity?: boolean

    Should connected clients skip sending keep-alive pings if other data is being regularly received? Enabling this option can help reduce data usage (especially on TLS-secured connections), but may cause compatibility issues with some real-world clients as they might treat an absence of pings to mean the connection to the server is lost.

    false

    maxBadMessages?: number

    The maximum number of non-conforming RPC messages which can be tolerated before the client is automatically closed.

    Infinity

    pingIntervalMs?: number

    Milliseconds between WebSocket pings to connected clients. Used for keep-alive timeouts.

    30000

    protocols?: string[]

    Array of subprotocols supported by this server. Can be overridden in an auth callback.

    []

    respondWithDetailedErrors?: boolean

    Specifies whether to send detailed errors (including stack trace) to remote party upon an error being thrown by a handler. This may be undesirable in a production environment as it leaks the call stack of the handler.

    false

    strictMode?: boolean | string[]

    Enable strict validation of calls & responses. Pass an array of subprotocol names to limit strict mode to specific protocols.

    false

    strictModeValidators?: Validator[]

    Optional additional validators to be used in conjunction with strictMode.

    []

    wssOptions?: ServerOptions<typeof WebSocket, typeof IncomingMessage>

    Additional WebSocketServer options from the WS library.

    {}

    Settings
    Member Visibility

    On This Page
    Properties