Class WebSocketTransportClient`Abstract`

A generic transport client for transports that use WebSockets to communicate with a backend.

Hierarchy

WebSocketTransportClient
- BetaSafetyBackendClient

Index

Constructors

Properties

_onPublishMessage _requestId? host messageQueue processServerMessage webSocket? defaultHost

Accessors

onPublishMessage ready

Methods

close connectTo send sendObj

Constructors

`Protected` constructor

new WebSocketTransportClient(requestId?, host?): WebSocketTransportClient
Parameters
- Optional requestId: string
- Optional host: string
Returns WebSocketTransportClient
- Defined in transport/webSocketTransportClient.ts:23

Properties

_onPublishMessage

_onPublishMessage: EventDispatcher<WebSocketTransportClient, EventPayload> = ...

`Protected` `Optional` _requestId

_requestId?: string

`Protected` host

host: string

`Private` messageQueue

messageQueue: any[] = []

`Abstract` processServerMessage

processServerMessage: ((arg0) => Promise<any>)

Type declaration

- (arg0): Promise<any>
- Parameters
  - arg0: any
  Returns Promise<any>

`Private` `Optional` webSocket

webSocket?: default

`Static` defaultHost

defaultHost: string = "ws://localhost:8090/ws"

Accessors

onPublishMessage

get onPublishMessage(): IEvent<WebSocketTransportClient, EventPayload>
Event that is dispatched whenever a socket event occurs.

Returns IEvent<WebSocketTransportClient, EventPayload>
- Defined in transport/webSocketTransportClient.ts:62

ready

get ready(): boolean
Returns whether the current transport is ready for messages.

Returns boolean
- Defined in transport/webSocketTransportClient.ts:69

Methods

close

close(): void
Closes the current socket transport.

Returns void
- Defined in transport/webSocketTransportClient.ts:125

`Protected` connectTo

connectTo(host?): undefined | default
Parameters
- Optional host: string
Returns undefined | default
- Defined in transport/webSocketTransportClient.ts:74

`Protected` send

send(message, callback?): void
Parameters
- message: string
- Optional callback: any
Returns void
- Defined in transport/webSocketTransportClient.ts:44

sendObj

sendObj(message, callback?): void
Sends an object to the server using the current socket connection.
Parameters
- message: object
  
  The object to serialize and send.
- Optional callback: (() => any)
  
  A callback to run after sending.
  - - (): any
    - Returns any
Returns void
- Defined in transport/webSocketTransportClient.ts:40

Generated using TypeDoc