Class StompRoomExchange

STOMP(WebSocket) protocol Live Room Info Exchange

Hierarchy

StompRoomExchange

Implements

IRoomExchange

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StompRoomExchange(client: StompClient): StompRoomExchange

- Defined in exchanges/room/StompRoomExchange.ts:11
Room Exchange, using Stomp protocol

Parameters
- client: StompClient
  
  StompClient instance
Returns StompRoomExchange

Properties

client

client: StompClient

subscriptionHMap

subscriptionHMap: ISubscriptionHMap

Methods

subscribe

subscribe(roomID: string, type?: string, msgCb: roomMessageCallback): string

- Defined in exchanges/room/StompRoomExchange.ts:28
subscribe to a Bilibili Live Room

Parameters
- roomID: string
  
  Bilibili Live Room ID
- Default value type: string = "*"
  
  Message Type
- msgCb: roomMessageCallback
  
  Message Callback Function
Returns string

Hash Map ID

unsubscribe

unsubscribe(id: string): void

Implementation of IRoomExchange.unsubscribe
- Defined in exchanges/room/StompRoomExchange.ts:42
Unsubscribe a live room by id in Hash Map ID

Parameters
- id: string
  
  Hash Map ID
Returns void

Generated using TypeDoc