Class WebSocketConnector

Hierarchy

WebSocketConnector

Index

Constructors

constructor

Properties

Methods

Object literals

handlers

Constructors

constructor

new WebSocketConnector(name: string): WebSocketConnector

- Defined in lib/websocket/connector.ts:18
Parameters
- name: string
Returns WebSocketConnector

Properties

Private closing

closing: boolean = false

Private connectionTimeout

connectionTimeout: Timeout

Private Readonly name

name: string

Private ws

ws: WebSocket

Methods

close

close(): void

- Defined in lib/websocket/connector.ts:37
Returns void

connect

connect(url: string): Promise<unknown>

- Defined in lib/websocket/connector.ts:44
Parameters
- url: string
Returns Promise<unknown>

isClosed

isClosed(): boolean

- Defined in lib/websocket/connector.ts:158
Returns boolean

onError

onError(func: (errorMessage: ErrorMessage) => void): this

- Defined in lib/websocket/connector.ts:24
Parameters
- func: (errorMessage: ErrorMessage) => void
  - - (errorMessage: ErrorMessage): void
    - Parameters
      - errorMessage: ErrorMessage
      Returns void
Returns this

onFile

onFile(func: (message: FileMessage) => void): this

- Defined in lib/websocket/connector.ts:32
Parameters
- func: (message: FileMessage) => void
  - - (message: FileMessage): void
    - Parameters
      - message: FileMessage
      Returns void
Returns this

onMessage

onMessage(func: (message: ServiceMessage) => void): this

- Defined in lib/websocket/connector.ts:28
Parameters
- func: (message: ServiceMessage) => void
  - - (message: ServiceMessage): void
    - Parameters
      - message: ServiceMessage
      Returns void
Returns this

Private onMessageReceived

onMessageReceived(data: any): void

- Defined in lib/websocket/connector.ts:95
Parameters
- data: any
Returns void

Private register

register(): void

- Defined in lib/websocket/connector.ts:91
Returns void

Private send

send(type: "reg_client" | "client_message", params: any): void

- Defined in lib/websocket/connector.ts:154
Parameters
- type: "reg_client" | "client_message"
- params: any
Returns void

Private tryReconnect

tryReconnect(url: any): void

- Defined in lib/websocket/connector.ts:144
Parameters
- url: any
Returns void

Object literals

Private handlers

handlers: object

error

error: null = null

file

file: null = null

message

message: null = null

Generated using TypeDoc