API Docs for: 0.1.0
Show:

vortexWebSocket Class

Module: vortex

Websocket interface

Constructor

vortexWebSocket

(
  • browser
  • config
)

Parameters:

  • browser VortexBrowser

    Crossbrowser library

  • config Object

    Configuration

Methods

_log

(
  • msg
)
private

Log message

Parameters:

  • msg Object

    Message

connect

()

Connect WebSocket

disconnect

()

Disconnect WebSocket

isConnected

() Boolean

Returns the connection status

Returns:

Boolean: True when a connection is open

send

(
  • data
)

Send a message

Parameters:

  • data String

    Message

Properties

_browser

VortexBrowser private

Crossbrowser library

_config

Object private

Configuration object

_connected

Boolean private

Indicates that a connection is open

_enabled

Boolean private

Indicates that the WebSocket feature is enabled in the browser

_socket

DOMWebSocket private

_url

String private

WebSocket target url