Class InnerBrowserStompSocket

Hierarchy

Reportable
- InnerBrowserStompSocket

Implements

IStompSocket

Constructors

constructor

new InnerBrowserStompSocket(config: Partial<StompSocketConfig>): InnerBrowserStompSocket

Overrides Reportable.constructor
Parameters
- config: Partial<StompSocketConfig>
Returns InnerBrowserStompSocket

Properties

Readonly __constructorName

__constructorName: string

listenerMap

listenerMap: Record<EventTargetType, IEventListenerObject[]>

Readonly reporter

reporter: Reporter

Static DEFAULT_EVENT_LISTENER_OPTIONS

DEFAULT_EVENT_LISTENER_OPTIONS: EventListenerOptions

Static IGNORE_FUNCTION_MEMBER

IGNORE_FUNCTION_MEMBER: PropertyKey[]

Static reporterManager

reporterManager: ReporterManager

Accessors

signalDestinations

get signalDestinations(): StompSocketDestinations

Implementation of IStompSocket.signalDestinations
Returns StompSocketDestinations

state

get state(): SocketState
set state(state: SocketState): void

Implementation of IStompSocket.state

实例的连接状态

Returns SocketState
Implementation of IStompSocket.state

实例的连接状态

Parameters
- state: SocketState
Returns void

Methods

addEventListener

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

Inherited from Reportable.addEventListener

添加事件监听器

Parameters
- type: EventTargetType
  要监听的事件类型
- func: EventListenerType
  事件监听回调
- Optional options: EventListenerOptions
Returns () => void
若添加成功则返回一个函数, 用于移除事件监听
- - (): void
  - 添加事件监听器
    
    Returns void
    若添加成功则返回一个函数, 用于移除事件监听

addEventListeners

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

Inherited from Reportable.addEventListeners

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

Parameters
- types: EventTargetType[]
  要监听的事件类型
- func: EventListenerType
  事件监听回调
- Optional options: EventListenerOptions
  设置监听器参数
Returns () => void
若添加成功则返回一个函数, 用于移除事件监听
- - (): void
  - 对多个事件添加同一个事件监听器
    
    Returns void
    若添加成功则返回一个函数, 用于移除事件监听

clearListener

clearListener(): void

Inherited from Reportable.clearListener

清空所有绑定的事件

Returns void

close

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

Implementation of IStompSocket.close
desc
关闭InnerBrowserStompSocket

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

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from Reportable.dispatchEvent

分发事件

Parameters
- event: Event
  分发的事件对象
Returns boolean
事件是否发送成功

dispatchEventLite

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

Inherited from Reportable.dispatchEventLite

简化的dispatchEvent接口

Parameters
- type: EventTargetType
- Optional message: EventTargetData
- Optional error: string | number
  具体错误类型, 此时 dispatchEventLite的 type 应是一个 xxxEventType.Error 类型
Returns boolean

hasListener

hasListener(type: EventTargetType): boolean

Inherited from Reportable.hasListener

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

Parameters
- type: EventTargetType
Returns boolean

refreshToken

refreshToken(token: string): void

刷新token

Parameters
- token: string
Returns void

removeEventListener

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

Inherited from Reportable.removeEventListener

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

Parameters
- type: EventTargetType
  要移除的事件监听器类型
- func: EventListenerType
  要移除的事件监听器
Returns boolean
返回 true 表示移除成功

send

send(data: SocketSendDataType, options?: Partial<StompSocketSendOptions>): Promise<void>

Implementation of IStompSocket.send
desc
通过WebSocket发送消息, 默认发送到StompSocketConfig.sendUrl地址

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

sendTo

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

Implementation of IStompSocket.sendTo
desc
可指定目的地的send方法

Parameters
- data: SocketSendDataType
- destination: string
  默认为StompSocketConfig.sendUrl
- Optional options: Partial<StompSocketSendOptions>
  发送消息时的可选项, 详见StompSocketSendOptions
Returns Promise<void>
Promise

toString

toString(): string

Inherited from Reportable.toString
Returns string

Generated using TypeDoc