API Docs for: 0.1.0
Show:

vortexWebSocket Class

Defined in: src/vortex/websocket.js:1
Module: vortex

Websocket interface

Constructor

vortexWebSocket

(
  • browser
  • config
)

Defined in src/vortex/websocket.js:1

Parameters:

  • browser VortexBrowser

    Crossbrowser library

  • config Object

    Configuration

Methods

_log

(
  • msg
)
private

Defined in src/vortex/websocket.js:92

Log message

Parameters:

  • msg Object

    Message

connect

()

Defined in src/vortex/websocket.js:107

Connect WebSocket

disconnect

()

Defined in src/vortex/websocket.js:163

Disconnect WebSocket

isConnected

() Boolean

Defined in src/vortex/websocket.js:179

Returns the connection status

Returns:

Boolean: True when a connection is open

send

(
  • data
)

Defined in src/vortex/websocket.js:191

Send a message

Parameters:

  • data String

    Message

Properties

_browser

VortexBrowser private

Defined in src/vortex/websocket.js:66

Crossbrowser library

_config

Object private

Defined in src/vortex/websocket.js:12

Configuration object

_connected

Boolean private

Defined in src/vortex/websocket.js:48

Indicates that a connection is open

_enabled

Boolean private

Defined in src/vortex/websocket.js:57

Indicates that the WebSocket feature is enabled in the browser

_socket

DOMWebSocket private

Defined in src/vortex/websocket.js:41

_url

String private

Defined in src/vortex/websocket.js:32

WebSocket target url