Interface IBroker

Hierarchy

IBroker

Implemented by

WebSocketBroker

Index

Properties

IsConnected SendMessage SetUserId Subscribe Unsubscribe

Properties

IsConnected

IsConnected: boolean

SendMessage

SendMessage: ((base) => void)

Type declaration

- (base): void
- Send message to server.
  Parameters
  - base: IMessageBase | MessageBroker.IMessage
  Returns void

SetUserId

SetUserId: ((userId) => void)

Type declaration

- (userId): void
- Parameters
  - userId: string
  Returns void

Subscribe

Subscribe: ((topic, callback, type?) => void)

Type declaration

- (topic, callback, type?): void
- Add a subscriber to a topic.
  Parameters
  - topic: string
  - callback: ((msg) => void)
    - (msg): void
      
      Parameters
      
      msg: MessageBroker.IMessage
      
      Returns void
  - Optional type: SubscribeType
  Returns void

Unsubscribe

Unsubscribe: ((topic, callback) => void)

Type declaration

- (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

Generated using TypeDoc