Class WebSocketBroker

Communicates with a server message broker.

Hierarchy

WebSocketBroker

Implements

IBroker

Index

Constructors

Properties

env maxReconnects reconnects subscriptions uri userId ws

Accessors

Methods

RequestTopicUsers SendMessage SetUserId Subscribe Unsubscribe addSubscriber connect formatApiUri onClose onError onMessage onOpen

Constructors

constructor

new WebSocketBroker(uri, env?): WebSocketBroker
Parameters
- uri: string
- Optional env: string
Returns WebSocketBroker
- Defined in server/message-broker.ts:72

Properties

`Private` env

env: string

`Private` maxReconnects

maxReconnects: number = 5

`Private` reconnects

reconnects: number = 0

`Private` subscriptions

subscriptions: Map<string, ((msg) => void)[]> = ...

`Private` uri

uri: string

`Private` userId

userId: string

`Private` ws

ws: WebSocket

Accessors

IsConnected

get IsConnected(): boolean
Returns boolean
Implementation of IBroker.IsConnected
- Defined in server/message-broker.ts:78

Methods

RequestTopicUsers

RequestTopicUsers(topic, callback): void
Parameters
- topic: string
- callback: ((msg) => void)
  - - (msg): void
    - Parameters
      
      msg: MessageBroker.IMessage
      
      Returns void
Returns void
- Defined in server/message-broker.ts:194

SendMessage

SendMessage(base): void
Send message to server.
Parameters
- base: IMessageBase | MessageBroker.IMessage
Returns void
Implementation of IBroker.SendMessage
- Defined in server/message-broker.ts:146

SetUserId

SetUserId(userId): void
Parameters
- userId: string
Returns void
Implementation of IBroker.SetUserId
- Defined in server/message-broker.ts:82

Subscribe

Subscribe(topic, callback, action?): void
Add a subscriber to a topic.
Parameters
- topic: string
- callback: ((msg) => void)
  - - (msg): void
    - Parameters
      
      msg: MessageBroker.IMessage
      
      Returns void
- Optional action: SubscribeType
Returns void
Implementation of IBroker.Subscribe
- Defined in server/message-broker.ts:175

Unsubscribe

Unsubscribe(topic, callback): void
Remove a subscriber from a topic.
Parameters
- topic: string
- callback: ((msg) => void)
  - - (msg): void
    - Parameters
      
      msg: MessageBroker.IMessage
      
      Returns void
Returns void
Implementation of IBroker.Unsubscribe
- Defined in server/message-broker.ts:188

`Private` addSubscriber

addSubscriber(topic, callback): void
Parameters
- topic: string
- callback: ((msg) => void)
  - - (msg): void
    - Parameters
      
      msg: MessageBroker.IMessage
      
      Returns void
Returns void
- Defined in server/message-broker.ts:132

`Private` connect

connect(): void
Returns void
- Defined in server/message-broker.ts:86

`Private` formatApiUri

formatApiUri(uri): string
Parameters
- uri: string
Returns string
- Defined in server/message-broker.ts:102

`Private` onClose

onClose(ev): void
Parameters
- ev: any
Returns void
- Defined in server/message-broker.ts:113

`Private` onError

onError(ev): void
Parameters
- ev: any
Returns void
- Defined in server/message-broker.ts:128

`Private` onMessage

onMessage(ev): void
Parameters
- ev: any
Returns void
- Defined in server/message-broker.ts:123

`Private` onOpen

onOpen(ev): void
Parameters
- ev: any
Returns void
- Defined in server/message-broker.ts:107

Generated using TypeDoc