WebStompSocket | wechat-conference-sdk

Web端StompSocket实现

Hierarchy

EventTarget
- WebStompSocket

Implements

StompSocket

Index

Constructors

constructor

Methods

Object literals

Constructors

constructor

new WebStompSocket(config: StompSocketConfig): WebStompSocket

Overrides EventTarget.constructor

desc

构造函数

Parameters
- config: StompSocketConfig
Returns WebStompSocket

Properties

_ackCountId

_ackCountId: number

_retryDataMap

_retryDataMap: Map<number, [SocketSendDataType, string, SocketSendOptions]>

储存需要响应ack的消息, 以 ackId 为key

_uncheckAckMessage

_uncheckAckMessage: () => void

Type declaration

- (): void
- Returns void

cacheDataQueue

cacheDataQueue: Array<[SocketSendDataType, string, SocketSendOptions]>

Socket连接断开或未连接的情况下将消息缓存的队列

connectUrl

connectUrl: string

enableACK

enableACK: boolean

headers

headers: StompSocketHeader

heartbeatUrl

heartbeatUrl: string

interval

interval: number

lastConsumeId

lastConsumeId: string

listenerMap

listenerMap: {}

Type declaration

[key: string]: Array<EventListenerType>

maxReconnectCount

maxReconnectCount: number

missingHeartbeat

missingHeartbeat: number

receiveUrl

receiveUrl: string

reconnectCount

reconnectCount: number

reconnectInterval

reconnectInterval: number

sendUrl

sendUrl: string

sockJSInst

sockJSInst: WebSocket

socket

socket: any

state

state: SocketState

timeout

timeout: number

unheartbeat

unheartbeat: SocketUnheartbeatType

Static HEARTBEAT_INTERVAL

HEARTBEAT_INTERVAL: number = 10 * 1000

默认的心跳间隔

Static MAX_RECONNECT_COUNT

MAX_RECONNECT_COUNT: number = 10

默认最大重连次数

Static RECONNECT_INTERVAL

RECONNECT_INTERVAL: number = 10 * 1000

默认重连间隔

Static TIMEOUT

TIMEOUT: number = 50 * 1000

默认心跳超时时间

Static reporter

reporter: Reporter = new Reporter('WebStompSocket')

Methods

_checkNoAckResponseMessage

_checkNoAckResponseMessage(interval?: number, timeout?: number): () => void

启动一个定时器, 以重新发送未响应ack的消息

Parameters
- Default value interval: number = 5000
  
  检查时间间隔, 单位: ms
- Default value timeout: number = 5000
  
  响应ack消息的超时时间
Returns () => void

返回一个函数用于取消定时器
- - (): void
  - Returns void

_dispatchMessage

_dispatchMessage(data: any): void

Parameters
- data: any
Returns void

_reconnect

_reconnect(): void

Returns void

Private _responseAckMessage

_responseAckMessage(ackId: number): void

响应一个ack消息

Parameters
- ackId: number
Returns void

_socketInit

_socketInit(headers: StompSocketHeader): Promise<unknown>

Parameters
- headers: StompSocketHeader
Returns Promise<unknown>

addEventListener

addEventListener(type: EventTargetType, func: EventListenerType, options?: EventListenerOptions): () => void

Inherited from EventTarget.addEventListener

添加事件监听器

Parameters
- type: EventTargetType
  
  要监听的事件类型
- func: EventListenerType
  
  事件监听回调
- Optional options: EventListenerOptions
Returns () => void

若添加成功则返回一个函数, 用于移除事件监听
- - (): void
  - Returns void

addEventListeners

addEventListeners(types: Array<EventTargetType>, func: EventListenerType, options?: EventListenerOptions): false | (Anonymous function)

Inherited from EventTarget.addEventListeners

对多个事件添加同一个事件监听器

Parameters
- types: Array<EventTargetType>
  
  要监听的事件类型
- func: EventListenerType
  
  事件监听回调
- Optional options: EventListenerOptions
  
  设置监听器参数
Returns false | (Anonymous function)

若添加成功则返回一个函数, 用于移除事件监听

clearListener

clearListener(): void

Inherited from EventTarget.clearListener

清空所有绑定的事件

Returns void

close

close(): Promise<unknown>

Implementation of StompSocket.close

desc

关闭WebStompSocket

Returns Promise<unknown>

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent

分发事件

Parameters
- event: Event
  
  分发的事件对象
Returns boolean

事件是否发送成功

dispatchEventLite

dispatchEventLite(type: EventTargetType, message?: EventTargetData, error?: string | number): void

Inherited from EventTarget.dispatchEventLite

Parameters
- type: EventTargetType
- Optional message: EventTargetData
- Optional error: string | number
Returns void

hasListener

hasListener(type: EventTargetType): boolean

Inherited from EventTarget.hasListener

指定类型的事件是否被监听

Parameters
- type: EventTargetType
Returns boolean

heartbeat

heartbeat(): SocketUnheartbeatType

Implementation of StompSocket.heartbeat

Returns SocketUnheartbeatType

removeEventListener

removeEventListener(type: EventTargetType, func: EventListenerType): boolean

Inherited from EventTarget.removeEventListener

移除事件监听器, 要提供与调用addEventListener或addEventListeners时相同的参数

Parameters
- type: EventTargetType
  
  要移除的事件监听器类型
- func: EventListenerType
  
  要移除的事件监听器
Returns boolean

返回true表示有该fun监听器并且移除成功

send

send(data: SocketSendDataType, options?: SocketSendOptions): Promise<any>

desc

通过WebSocket发送消息, 默认发送到StompSocketConfig.sendUrl地址

Parameters
- data: SocketSendDataType
- Optional options: SocketSendOptions
  
  发送消息时的可选项, 详见SocketSendOptions
Returns Promise<any>

sendTo

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

Implementation of StompSocket.sendTo

desc

可指定目的地的{@link WebSocket.send}方法

Parameters
- data: SocketSendDataType
- destination: string
  
  默认为StompSocketConfig.sendUrl
- Default value options: SocketSendOptions = {}
  
  发送消息时的可选项, 详见SocketSendOptions
Returns Promise<any>

Promise

Object literals

Static DEFAULT_EVENT_LISTENER_OPTIONS

DEFAULT_EVENT_LISTENER_OPTIONS: object

once

once: false = false

Static DEFAULT_SOCKET_CONFIG

DEFAULT_SOCKET_CONFIG: object

默认的StompSocketConfig配置

connectUrl

connectUrl: null = null

enableACK

enableACK: true = true

headers

headers: null = null

heartbeatUrl

heartbeatUrl: string = "/acd/heartbeat"

interval

interval: number = WebStompSocket.HEARTBEAT_INTERVAL

maxReconnectCount

maxReconnectCount: number = WebStompSocket.MAX_RECONNECT_COUNT

receiveUrl

receiveUrl: null = null

reconnectInterval

reconnectInterval: number = WebStompSocket.RECONNECT_INTERVAL

sendUrl

sendUrl: string = "/acd/set/data"

timeout

timeout: number = Math.ceil(WebStompSocket.TIMEOUT / WebStompSocket.HEARTBEAT_INTERVAL)

Hierarchy

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

config: StompSocketConfig

Returns WebStompSocket

Properties

_ackCountId

_retryDataMap

_uncheckAckMessage

Type declaration

Returns void

cacheDataQueue

connectUrl

enableACK

headers

heartbeatUrl

interval

lastConsumeId

listenerMap

Type declaration

[key: string]: Array<EventListenerType>

maxReconnectCount

missingHeartbeat

receiveUrl

reconnectCount

reconnectInterval

sendUrl

sockJSInst

socket

state

timeout

unheartbeat

Static HEARTBEAT_INTERVAL

Static MAX_RECONNECT_COUNT

Static RECONNECT_INTERVAL

Static TIMEOUT

Static reporter

Methods

_checkNoAckResponseMessage

Parameters

Default value interval: number = 5000

Default value timeout: number = 5000

Returns () => void

Returns void

_dispatchMessage

Parameters

data: any

Returns void

_reconnect

Returns void

Private _responseAckMessage

Parameters

ackId: number

Returns void

_socketInit

Parameters

headers: StompSocketHeader

Returns Promise<unknown>

addEventListener

Parameters

type: EventTargetType

func: EventListenerType

Optional options: EventListenerOptions

Returns () => void

Returns void

addEventListeners

Parameters

types: Array<EventTargetType>

func: EventListenerType

Optional options: EventListenerOptions

Returns false | (Anonymous function)

clearListener

Returns void