Interface StompSocket

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

Hierarchy

Socket
- StompSocket

Implemented by

Index

Properties

state

Methods

Properties

state

state: SocketState

Methods

close

close(): Promise<any>

Inherited from Socket.close

关闭连接, 成功后会收到SocketEventType.CLOSED事件.

Returns Promise<any>

heartbeat

heartbeat(): SocketUnheartbeatType

Inherited from Socket.heartbeat

发送心跳, 保持连接

Returns SocketUnheartbeatType

send

send(data: SocketSendDataType): Promise<any>

Inherited from Socket.send

发送数据, 接受{@link string}, Object类型, 内部会将Object转换为{@link string}类型.

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

sendTo

sendTo(data: SocketSendDataType, destination: string, options?: SocketSendOptions): Promise<any>

desc

可指定目的地的Socket.send方法

Parameters
- data: SocketSendDataType
- destination: string
  
  目的地
- Optional options: SocketSendOptions
  
  发送消息的可选项
Returns Promise<any>

Promise

Generated using TypeDoc