Classdefault

constructor

• new default(name, webSocket, propagateEventMethod, rpcMethodDetailsByMethodName): "main/services/rpc-server".default

• Parameters

  • name: string
  • webSocket: WebSocket
  • propagateEventMethod: PropagateEventMethod
  • rpcMethodDetailsByMethodName: Map<string, RegisteredRpcMethodDetails>

  Returns "main/services/rpc-server".default

connectionStatus

connect

• connect(): Promise<boolean>

• 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

disconnect

• disconnect(): Promise<void>

• Disconnects from the connection:

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

  Returns Promise<void>

emitEventOnNetwork

• emitEventOnNetwork<T>(eventType, event): 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

registerRemoteMethod

• registerRemoteMethod(methodName, methodDocs?): boolean

• Parameters

  • methodName: string
  • OptionalmethodDocs: SingleMethodDocumentation

  Returns boolean

request

• request(requestType, requestParams): Promise<JSONRPCResponse>

• 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

unregisterRemoteMethod

• unregisterRemoteMethod(methodName): boolean

• Parameters

  • methodName: string

  Returns boolean