Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RpcProtocol

Establish a bi-directional RPC protocol on top of a given channel. Bi-directional means to send sends requests and notifications to the remote side as well as receiving requests and notifications from the remote side. Clients can get a promise for a remote request result that will be either resolved or rejected depending on the success of the request. Keeps track of outstanding requests and matches replies to the appropriate request Currently, there is no timeout handling for long running requests implemented.

Hierarchy

  • RpcProtocol

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected Readonly cancellationTokenSources

cancellationTokenSources: Map<number, CancellationTokenSource> = ...

Readonly channel

channel: Channel

Protected Readonly decoder

decoder: RpcMessageDecoder

Protected Readonly encoder

encoder: RpcMessageEncoder

Protected nextMessageId

nextMessageId: number = 0

Protected Readonly onNotificationEmitter

onNotificationEmitter: Emitter<{ args: any[]; method: string }> = ...

Protected Readonly pendingRequests

pendingRequests: Map<number, Deferred<any>> = ...

Readonly requestHandler

requestHandler: RequestHandler

Protected toDispose

toDispose: DisposableCollection = ...

Static Readonly CANCELLATION_TOKEN_KEY

CANCELLATION_TOKEN_KEY: "add.cancellation.token" = 'add.cancellation.token'

Accessors

onNotification

  • get onNotification(): Event<{ args: any[]; method: string }>

Methods

cancelError

  • cancelError(): Error

Protected handleCancel

  • handleCancel(id: number): void

handleMessage

Protected handleNotify

  • handleNotify(id: number, method: string, args: any[]): Promise<void>

Protected handleReply

  • handleReply(id: number, value: any): void

Protected handleReplyErr

  • handleReplyErr(id: number, error: any): void

Protected handleRequest

  • handleRequest(id: number, method: string, args: any[]): Promise<void>

sendCancel

  • sendCancel(requestId: number): void

sendNotification

  • sendNotification(method: string, args: any[]): void

sendRequest

  • sendRequest<T>(method: string, args: any[]): Promise<T>