Class RPCServer

Hierarchy

StartStop
- RPCServer

Constructors

constructor

new RPCServer(__namedParameters): RPCServer
RPCServer Constructor
Parameters
- __namedParameters: {
      fromError?: FromError;
      idGen?: IdGen;
      logger?: Logger;
      middlewareFactory?: MiddlewareFactory<JSONRPCRequest, Uint8Array, Uint8Array, JSONRPCResponseSuccess>;
      replacer?: ((key, value) => any);
      timeoutTime?: number;
  }
  - Optional fromError?: FromError
  - Optional idGen?: IdGen
  - Optional logger?: Logger
  - Optional middlewareFactory?: MiddlewareFactory<JSONRPCRequest, Uint8Array, Uint8Array, JSONRPCResponseSuccess>
  - Optional replacer?: ((key, value) => any)
    - (key, value): any
      
      Parameters
      
      key: string
      
      value: any
      
      Returns any
  - Optional timeoutTime?: number
Returns RPCServer
Inherited from startStop.StartStop.constructor
- Defined in src/RPCServer.ts:89

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` activeStreams

activeStreams: Set<PromiseCancellable<void>> = ...

`Protected` defaultTimeoutMap

defaultTimeoutMap: Map<string, undefined | number> = ...

`Protected` fromError

fromError: FromError

`Protected` handlerMap

handlerMap: Map<string, RawHandlerImplementation> = ...

`Protected` idGen

idGen: IdGen

`Protected` logger

logger: Logger

`Protected` middlewareFactory

middlewareFactory: MiddlewareFactory<JSONRPCRequest, Uint8Array, Uint8Array, JSONRPCResponseSuccess>

`Protected` `Optional` onTimeoutCallback

onTimeoutCallback?: (() => void)

Type declaration

- (): void
- Returns void

`Protected` `Optional` replacer

replacer?: ((key, value) => any)

Type declaration

- (key, value): any
- Parameters
  - key: string
  - value: any
  Returns any

`Protected` timeoutTime

timeoutTime: number

Accessors

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from startStop.StartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from startStop.StartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from startStop.StartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from startStop.StartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from startStop.StartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/StartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from startStop.StartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/StartStop.d.ts:8

[status]

get [status](): Status
Returns Status
Inherited from startStop.StartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/StartStop.d.ts:7

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from startStop.StartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from startStop.StartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

handleStream

handleStream(rpcStream): void
ID is associated with the stream, not individual messages.
Parameters
- rpcStream: RPCStream<Uint8Array, Uint8Array, POJO>
Returns void
- Defined in src/RPCServer.ts:456

`Protected` registerClientStreamHandler

registerClientStreamHandler<I, O>(method, handler, timeout): void
Type Parameters
- I extends JSONObject
- O extends JSONObject
Parameters
- method: string
- handler: ClientHandlerImplementation<I, O>
- timeout: undefined | number
Returns void
- Defined in src/RPCServer.ts:434

`Protected` registerDuplexStreamHandler

registerDuplexStreamHandler<I, O>(method, handler, timeout): void
The ID is generated only once when the function is called and stored in the id variable. the ID is associated with the entire stream Every response (whether successful or an error) produced within this stream will have the same ID, which is consistent with the originating request.
Type Parameters
- I extends JSONObject
- O extends JSONObject
Parameters
- method: string
- handler: DuplexHandlerImplementation<I, O>
- timeout: undefined | number
Returns void
- Defined in src/RPCServer.ts:254

registerOnTimeoutCallback

registerOnTimeoutCallback(callback): void
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in src/RPCServer.ts:72

`Protected` registerRawStreamHandler

registerRawStreamHandler(method, handler, timeout): void
Registers a raw stream handler. This is the basis for all handlers as handling the streams is done with raw streams only. The raw streams do not automatically refresh the timeout timer when messages are sent or received.
Parameters
- method: string
- handler: RawHandlerImplementation
- timeout: undefined | number
Returns void
- Defined in src/RPCServer.ts:230

`Protected` registerServerStreamHandler

registerServerStreamHandler<I, O>(method, handler, timeout): void
Type Parameters
- I extends JSONObject
- O extends JSONObject
Parameters
- method: string
- handler: ServerHandlerImplementation<I, O>
- timeout: undefined | number
Returns void
- Defined in src/RPCServer.ts:412

`Protected` registerUnaryHandler

registerUnaryHandler<I, O>(method, handler, timeout): void
Type Parameters
- I extends JSONObject
- O extends JSONObject
Parameters
- method: string
- handler: UnaryHandlerImplementation<I, O>
- timeout: undefined | number
Returns void
- Defined in src/RPCServer.ts:387

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from startStop.StartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

start

start(obj): Promise<void>
Starts RPC server.
Parameters
- obj: {
  manifest: ServerManifest;
  }
  - manifest: ServerManifest
    
    Server manifest used to define the rpc method handlers.
Returns Promise<void>
Inherited from startStop.StartStop.start
- Defined in src/RPCServer.ts:126

stop

stop(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
  force?: boolean;
  reason?: any;
  }
  - Optional force?: boolean
  - Optional reason?: any
Returns Promise<void>
Inherited from startStop.StartStop.stop
- Defined in src/RPCServer.ts:198

Class RPCServer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { fromError?: FromError; idGen?: IdGen; logger?: Logger; middlewareFactory?: MiddlewareFactory<JSONRPCRequest, Uint8Array, Uint8Array, JSONRPCResponseSuccess>; replacer?: ((key, value) => any); timeoutTime?: number; }

Optional fromError?: FromError

Optional idGen?: IdGen

Optional logger?: Logger

Optional middlewareFactory?: MiddlewareFactory<JSONRPCRequest, Uint8Array, Uint8Array, JSONRPCResponseSuccess>

Optional replacer?: ((key, value) => any)

Parameters

key: string

value: any

Returns any

Optional timeoutTime?: number

Returns RPCServer

Properties

Readonly [initLock]

Protected activeStreams

Protected defaultTimeoutMap

Protected fromError

Protected handlerMap

Protected idGen

Protected logger

Protected middlewareFactory

Protected Optional onTimeoutCallback

Type declaration

Returns void

Protected Optional replacer

Type declaration

Parameters

key: string

value: any

Returns any

Protected timeoutTime

Accessors

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[running]

Returns boolean

[statusP]

Returns Promise<Status>

[status]

Returns Status

Methods

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

handleStream

Parameters

rpcStream: RPCStream<Uint8Array, Uint8Array, POJO>

Returns void

Protected registerClientStreamHandler

Type Parameters

I extends JSONObject

O extends JSONObject

Parameters

method: string

__namedParameters: {
fromError?: FromError;
idGen?: IdGen;
logger?: Logger;
middlewareFactory?: MiddlewareFactory<JSONRPCRequest, Uint8Array, Uint8Array, JSONRPCResponseSuccess>;
replacer?: ((key, value) => any);
timeoutTime?: number;
}

`Optional` fromError?: FromError

`Optional` idGen?: IdGen

`Optional` logger?: Logger

`Optional` middlewareFactory?: MiddlewareFactory<JSONRPCRequest, Uint8Array, Uint8Array, JSONRPCResponseSuccess>

`Optional` replacer?: ((key, value) => any)

`Optional` timeoutTime?: number

`Readonly` [initLock]

`Protected` activeStreams

`Protected` defaultTimeoutMap

`Protected` fromError

`Protected` handlerMap

`Protected` idGen

`Protected` logger

`Protected` middlewareFactory

`Protected` `Optional` onTimeoutCallback

`Protected` `Optional` replacer

`Protected` timeoutTime

`Optional` options: boolean | AddEventListenerOptions

`Protected` registerClientStreamHandler

`Protected` registerDuplexStreamHandler

`Protected` registerRawStreamHandler

`Protected` registerServerStreamHandler

`Protected` registerUnaryHandler

`Optional` options: boolean | EventListenerOptions

obj: {
manifest: ServerManifest;
}

__namedParameters: {
force?: boolean;
reason?: any;
}

`Optional` force?: boolean

`Optional` reason?: any