Module "internal/transport/websocket/WebSocketClient"

Index

Classes

WebSocketClient

Interfaces

Variables

Functions

Variables

Let ping

ping: number = 0

Let pong

pong: any

promiseRetry

promiseRetry: promiseRetry

Let reconnect

reconnect: boolean = true

Let ws

ws: any

Functions

connect

connect(registrationCallback: () => any, registration: RegistrationConfirmation, configuration: Configuration, requestProcessor: WebSocketRequestProcessor): Promise<WebSocket>

- Defined in lib/internal/transport/websocket/WebSocketClient.ts:57
Parameters
- registrationCallback: () => any
  - - (): any
    - Returns any
- registration: RegistrationConfirmation
- configuration: Configuration
- requestProcessor: WebSocketRequestProcessor
Returns Promise<WebSocket>

isControl

isControl(a: any): a is Control

- Defined in lib/internal/transport/websocket/WebSocketClient.ts:247
Parameters
- a: any
Returns a is Control

isPing

isPing(a: any): a is Ping

- Defined in lib/internal/transport/websocket/WebSocketClient.ts:239
Parameters
- a: any
Returns a is Ping

isPong

isPong(a: any): a is Pong

- Defined in lib/internal/transport/websocket/WebSocketClient.ts:243
Parameters
- a: any
Returns a is Pong

register

register(registrationCallback: () => any, configuration: Configuration, handler: WebSocketRequestProcessor, retries?: number): Promise<RegistrationConfirmation>

- Defined in lib/internal/transport/websocket/WebSocketClient.ts:173
Parameters
- registrationCallback: () => any
  - - (): any
    - Returns any
- configuration: Configuration
- handler: WebSocketRequestProcessor
- Default value retries: number = 100
Returns Promise<RegistrationConfirmation>

Generated using TypeDoc