Class WebSocketConnector

Hierarchy

WebSocketConnector

Index

Constructors

Properties

observers socket url websockets

Methods

close open openStream create

Constructors

constructor

new WebSocketConnector(url: string): WebSocketConnector
url
Parameters
- url: string
Returns WebSocketConnector
- Defined in lib/connector/WebSocketConnector.ts:60

Properties

`Private` observers

observers: {
[subscriberId: string]: Subscriber<ChannelMessage>;
} = {}

Type declaration

[subscriberId: string]: Subscriber<ChannelMessage>

`Private` socket

socket: null | Promise<w3cwebsocket> = null

`Private` url

url: string

`Static` `Private` websockets

websockets: {
[origin: string]: WebSocketConnector;
} = {}

Map of all available connectors to their respective websocket connections

Type declaration

[origin: string]: WebSocketConnector

Methods

close

close(): void
Returns void
- Defined in lib/connector/WebSocketConnector.ts:137

open

open(): Promise<w3cwebsocket>
Returns Promise<w3cwebsocket>
- Defined in lib/connector/WebSocketConnector.ts:64

openStream

openStream(tokenStorage: TokenStorage, id: string): ObservableStream
tokenStorage id subscription ID The channel for sending and receiving messages
Parameters
- tokenStorage: TokenStorage
- id: string
Returns ObservableStream
- Defined in lib/connector/WebSocketConnector.ts:151

`Static` create

create(url: string): WebSocketConnector
url The websocket connect script url a websocket connection
Parameters
- url: string
Returns WebSocketConnector
- Defined in lib/connector/WebSocketConnector.ts:48

Generated using TypeDoc