Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TinyRpcClient

example

创建 client

let ins: TinyRpcClient =new TinyRpcClient("ws://localhost:3030") as any;
ins.on("connect", () => {
     //调用远程方法
    ins.callMethod("add", [1, 2])
        .then(result => {
            console.log("result equal 3", result);
        })
})

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Properties

Protected _listener

_listener: any = {} as any

beActive

beActive: boolean = true

激活/禁用 事件管理器，在激活状态下，触发事件才会触发监听器

Protected opts

opts: IRpcClientOptions

Private rpcCall

rpcCall: Map<string, { reject: (err: Error) => void; resolve: (result: any) => void }> = new Map<string, { resolve: (result: any) => void, reject: (err: Error) => void }>()

Accessors

beOpen

  • get beOpen(): boolean

Methods

callMethod

  • callMethod<T>(methodName: string, params: any[]): Promise<T>

  • rpc调用

    Type parameters

    • T = any

    Parameters

    • methodName: string
    • params: any[]

    Returns Promise<T>

dispose

  • dispose(): void

emit

  • emit<K>(ev: K, params?: WSClientEventMap[K]): void

Private handleTimeout

  • handleTimeout(id: string): void

off

  • off<K>(ev: K, callback: (ev: WSClientEventMap[K]) => void): void

  • 取消对指定事件的监听

    Type parameters

    Parameters

    • ev: K

      事件str

    • callback: (ev: WSClientEventMap[K]) => void

      监听函数

        • (ev: WSClientEventMap[K]): void

        • Parameters

          • ev: WSClientEventMap[K]

          Returns void

    Returns void

on

  • on<K>(ev: K, callback: (ev: WSClientEventMap[K]) => void): void

  • 为指定事件添加一个监听器到监听器数组的尾部

    Type parameters

    Parameters

    • ev: K

      事件str

    • callback: (ev: WSClientEventMap[K]) => void

      监听函数

        • (ev: WSClientEventMap[K]): void

        • Parameters

          • ev: WSClientEventMap[K]

          Returns void

    Returns void

Protected onmessage

  • onmessage(ev: MessageEvent): void

removeAllListeners

  • removeAllListeners(): void

removeEventListeners

  • removeEventListeners<K>(ev: K): void

sendMessage

  • sendMessage(data: any): void

Static connect

  • connect<T>(this: {}, url: string, options?: IwsOpts): T

  • 创建wsClient, 不需要等待连接建立

    Type parameters

    • T

    Parameters

    • this: {}
    • url: string

      ws服务器地址

    • Optional options: IwsOpts

    Returns T

Static connectSync

Object literals

interceptors

interceptors: object

receive

receive: Interceptor<any> = new Interceptor(this._receiveMessage)

send

send: Interceptor<any> = new Interceptor(this._sendMessage)

Generated using TypeDoc