Interface IStompSocket

接口继承自ISocket, 通过STOMP协议进行消息交换, 使用stompjs库覆盖WebSocket。

Hierarchy

ISocket
- IStompSocket

Implemented by

InnerBrowserStompSocket

Index

Properties

Methods

Properties

signalDestinations

signalDestinations: StompSocketDestinations

state

state: SocketState

实例的连接状态

Methods

close

close(code: number, reason?: string): Promise<void>

Inherited from ISocket.close

关闭连接

Parameters
- code: number
- Optional reason: string
Returns Promise<void>

send

send(data: SocketSendDataType): Promise<void>

Inherited from ISocket.send

发送消息, 传入的非字符串类型将会通过{@link JSON.stringify}转化为JSON字符串.

Parameters
- data: SocketSendDataType
  要发送的数据
Returns Promise<void>

sendTo

sendTo(data: SocketSendDataType, destination: string, options?: StompSocketSendOptions): Promise<void>

集成 stompjs , 可指定消息发送的地址.

Parameters
- data: SocketSendDataType
- destination: string
  消息发送的地址
- Optional options: StompSocketSendOptions
  发送消息的可选项
Returns Promise<void>

Generated using TypeDoc