Class BrowserWebSocketImpl

Uses a browser Websocket.

Hierarchy

CloverWebSocketInterface
- BrowserWebSocketImpl

Index

Constructors

constructor

Methods

Constructors

constructor

new BrowserWebSocketImpl(endpoint: string): BrowserWebSocketImpl

Overrides CloverWebSocketInterface.constructor
- Defined in websocket/BrowserWebSocketImpl.ts:8
Parameters
- endpoint: string
Returns BrowserWebSocketImpl

Methods

addListener

addListener(listener: WebSocketListener): void

Inherited from CloverWebSocketInterface.addListener
- Defined in websocket/CloverWebSocketInterface.ts:164
Parameters
- listener: WebSocketListener
Returns void

connect

connect(): CloverWebSocketInterface

Inherited from CloverWebSocketInterface.connect
- Defined in websocket/CloverWebSocketInterface.ts:44
Returns CloverWebSocketInterface

createWebSocket

createWebSocket(endpoint: string): any

Overrides CloverWebSocketInterface.createWebSocket
- Defined in websocket/BrowserWebSocketImpl.ts:20
override

Parameters
- endpoint: string
  
  the url that will connected to
Returns any
- the specific implementation of a websocket

getBufferedAmount

getBufferedAmount(): number

Inherited from CloverWebSocketInterface.getBufferedAmount
- Defined in websocket/CloverWebSocketInterface.ts:190
Returns number

getListeners

getListeners(): Array<WebSocketListener>

Inherited from CloverWebSocketInterface.getListeners
- Defined in websocket/CloverWebSocketInterface.ts:177
Returns Array<WebSocketListener>

getProtocol

getProtocol(): string

Inherited from CloverWebSocketInterface.getProtocol
- Defined in websocket/CloverWebSocketInterface.ts:194
Returns string

getReadyState

getReadyState(): WebSocketState

Inherited from CloverWebSocketInterface.getReadyState
- Defined in websocket/CloverWebSocketInterface.ts:186
Returns WebSocketState

getState

getState(): WebSocketState

Inherited from CloverWebSocketInterface.getState
- Defined in websocket/CloverWebSocketInterface.ts:146
Returns WebSocketState

getUrl

getUrl(): String

Inherited from CloverWebSocketInterface.getUrl
- Defined in websocket/CloverWebSocketInterface.ts:182
Returns String

isOpen

isOpen(): boolean

Inherited from CloverWebSocketInterface.isOpen
- Defined in websocket/CloverWebSocketInterface.ts:150
Returns boolean

removeListener

removeListener(listener: WebSocketListener): boolean

Inherited from CloverWebSocketInterface.removeListener
- Defined in websocket/CloverWebSocketInterface.ts:168
Parameters
- listener: WebSocketListener
Returns boolean

sendClose

sendClose(code?: number, reason?: string): CloverWebSocketInterface

Inherited from CloverWebSocketInterface.sendClose
- Defined in websocket/CloverWebSocketInterface.ts:118
Parameters
- Optional code: number
- Optional reason: string
Returns CloverWebSocketInterface

sendPing

sendPing(): CloverWebSocketInterface

Overrides CloverWebSocketInterface.sendPing
- Defined in websocket/BrowserWebSocketImpl.ts:34
Browser implementations do not do ping frames

Returns CloverWebSocketInterface

sendPong

sendPong(): CloverWebSocketInterface

Overrides CloverWebSocketInterface.sendPong
- Defined in websocket/BrowserWebSocketImpl.ts:27
Browser implementations do not do pong frames

Returns CloverWebSocketInterface

sendText

sendText(data: string): CloverWebSocketInterface

Inherited from CloverWebSocketInterface.sendText
- Defined in websocket/CloverWebSocketInterface.ts:133
Parameters
- data: string
Returns CloverWebSocketInterface

Static createInstance

createInstance(endpoint: string): BrowserWebSocketImpl

- Defined in websocket/BrowserWebSocketImpl.ts:44
Create an instance of this class

Parameters
- endpoint: string
Returns BrowserWebSocketImpl

Generated using TypeDoc