Class WebsocketClient Abstract

This is a base class to implement websocket

Hierarchy

WebsocketClient

Index

Constructors

constructor

Methods

Constructors

constructor

new WebsocketClient(): WebsocketClient

Returns WebsocketClient

Methods

attemptReconnect

attemptReconnect(reconnectInfo: WsReconnectInfo, wsWorker?: any): void

example
```
attemptReconnect({reconnectInterval: 300, reconnectAttempts:4});
```
Parameters
- reconnectInfo: WsReconnectInfo
  
  reconnectIntervalInMs in millisecond, maxReconnectAttempts in number and ws url
- Optional wsWorker: any
Returns void

checkWSEvent

checkWSEvent(wsResponse: WsResponse): void

This method to perform the different actions on callback response
example
```
checkWSEvent(event);
```
Parameters
- wsResponse: WsResponse
Returns void

close

close(wsWorker?: any): void

This function used to close connection with websocket server
example
```
close();
```
Parameters
- Optional wsWorker: any
Returns void

connect

connect(websocketUrl: string, wsWorker?: any): void

This function used to make connection with websocket server
example
```
connect('ws://localhost:8089');
```
Parameters
- websocketUrl: string
- Optional wsWorker: any
Returns void

Protected Abstract onClosed

onClosed(): void

Completed callback method for websocket Subscription

Returns void

Protected Abstract onError

onError(): void

Error callback method for websocket Subscription

Returns void

Protected Abstract onMessage

onMessage(msg: any): void

Callback method when a message received from websocket server

Parameters
- msg: any
  
  message from server
Returns void

Protected Abstract onOpen

onOpen(): void

Callback method when a connection is ready to send and receive data

Returns void

Protected Abstract onReconnect

onReconnect(msg?: WsReconnectResponse): void

Callback method when a ws reconnect attempts in progress

Parameters
- Optional msg: WsReconnectResponse
Returns void

Protected Abstract onReconnectComplete

onReconnectComplete(): void

Callback method when a ws reconnect attempts are completed

Returns void

Protected onReconnectSuccess

onReconnectSuccess(): void

Callback method when a ws reconnect attempts was successful
example
- this.onReconnectSuccess()
Returns void

sendMessage

sendMessage(msg: unknown, wsWorker: any): void

Method to send to websocket worker
example
```
sendMessage('hi');
```
Parameters
- msg: unknown
  
  message send to websocket
- wsWorker: any
Returns void

Generated using TypeDoc