Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WeChatSocket

兼容微信小程序的StompSocket实现

Hierarchy

  • EventTarget
    • WeChatSocket

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

cacheDataQueue

cacheDataQueue: [SocketSendDataType, string][]

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

connectUrl

connectUrl: string

连接url

headers

headers: StompSocketHeader

socket头部

heartbeatUrl

heartbeatUrl: string

心跳url

interval

interval: number = ...

时间间隔

lastConsumeId

lastConsumeId: string

最新消耗id

maxReconnectCount

maxReconnectCount: number = ...

最大重连次数

missingHeartbeat

missingHeartbeat: number

丢失心跳的次数, 超过MAX_RECONNECT_COUNT次数表示连接断开

receiveUrl

receiveUrl: string

接收url

reconnectCount

reconnectCount: number

重连次数

reconnectInterval

reconnectInterval: number = ...

重连间隔

reporter

reporter: Reporter = ...

sendUrl

sendUrl: string

发送url

socket

socket: any

Stomp实例

state

state: SocketState

状态

timeout

timeout: number = ...

超时时间

unheartbeat

unheartbeat: SocketUnheartbeatType

wsInst

wsInst: WebSocket

WebSocket实例

Static DEFAULT_SOCKET_CONFIG

DEFAULT_SOCKET_CONFIG: StompSocketConfig = ...

默认的StompSocketConfig配置

Static HEARTBEAT_INTERVAL

HEARTBEAT_INTERVAL: number = ...

默认的心跳间隔

Static MAX_RECONNECT_COUNT

MAX_RECONNECT_COUNT: number = 10

默认最大重连次数

Static TIMEOUT

TIMEOUT: number = ...

默认心跳超时时间

Static reporter

reporter: Reporter = ...

Methods

_dispatchErrorMessage

  • _dispatchErrorMessage(data: any): void

  • Parameters

    • data: any

    Returns void

addEventListener

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

  • 添加事件监听器

    Parameters

    • type: EventTargetType

      要监听的事件类型

    • func: EventListenerType

      事件监听回调

    • Optional options: EventListenerOptions

    Returns () => void

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

      • (): void

      • Returns void

addEventListeners

  • addEventListeners(types: EventTargetType[], func: EventListenerType, options?: EventListenerOptions): false | (() => void)

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

    Parameters

    • types: EventTargetType[]

      要监听的事件类型

    • func: EventListenerType

      事件监听回调

    • Optional options: EventListenerOptions

      设置监听器参数

    Returns false | (() => void)

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

clearListener

  • clearListener(): void

  • 清空所有绑定的事件

    Returns void

close

  • close(code?: number, reason?: any): Promise<unknown>
  • desc

    关闭WeChatSocket

    Parameters

    • code: number = 4444
    • Optional reason: any

    Returns Promise<unknown>

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • 分发事件

    Parameters

    • event: Event

      分发的事件对象

    Returns boolean

    事件是否发送成功

dispatchEventLite

  • dispatchEventLite(type: EventTargetType, message?: any, error?: EventTargetType): void

  • 简化分发事件接口, 如需要分发的是错误事件, error参数传入具体错误类型

    Parameters

    • type: EventTargetType

      事件类型

    • Optional message: any

      消息

    • Optional error: EventTargetType

      错误类型

    Returns void

hasListener

  • hasListener(type: EventTargetType): boolean

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

    Parameters

    • type: EventTargetType

    Returns boolean

refreshToken

  • refreshToken(token: string): void

  • 刷新token

    Parameters

    • token: string

    Returns void

removeEventListener

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

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

    Parameters

    • type: EventTargetType

      要移除的事件监听器类型

    • func: EventListenerType

      要移除的事件监听器

    Returns boolean

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

send

  • send(data: SocketSendDataType): Promise<any>

sendTo

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

Generated using TypeDoc