papi-dts
    Preparing search index...

    Manages the JSON-RPC protocol on the server end of a websocket owned by main. This class is not intended to be instantiated by anything other than RpcWebSocketListener.

    Created by RpcWebSocketListener when a client connects to the web socket server. There is one RpcServer object per client that connects to the web socket server.

    Implements

    Index

    Constructors

    Properties

    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

    Methods

    • Sets up the RPC handler by populating connector info, setting up event handlers, and doing one of the following:

      • On clients: connecting to the server
      • On servers: opening an endpoint for clients to connect

      Returns Promise<boolean>

      Promise that resolves when finished connecting

    • Disconnects from the connection:

      • On clients: disconnects from the server
      • On servers: disconnects from all clients and closes its connection endpoint

      Returns Promise<void>

    • Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

      Type Parameters

      • T

      Parameters

      • eventType: string

        Unique network event type for coordinating between processes

      • event: T

        Event data to emit on the network

      Returns void

    • Send a request and resolve after receiving a response

      Parameters

      • requestType: `${string}:${string}`

        Type of request (or "method" in JSONRPC jargon) to call

      • requestParams: RequestParams

        Parameters associated with this request

      Returns Promise<JSONRPCResponse>

      Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message