API Docs for: 0.1.0
Show:

vortexClient Class

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

Vortex client

Constructor

vortexClient

(
  • browser
  • config
)

Defined in src/vortex/client.js:1

Parameters:

  • browser VortexBrowser

    Crossbrowser library

  • config Object

    Configuration

Methods

_log

(
  • msg
)
private

Defined in src/vortex/client.js:151

Log message

Parameters:

  • msg Object

    Message

_onClose

(
  • event
)
private

Defined in src/vortex/client.js:91

Close event handler

Parameters:

  • event Object

    DOMEvent

_onError

(
  • event
)
private

Defined in src/vortex/client.js:106

Error event handler

Parameters:

  • event Object

    DOMEvent

_onMessage

(
  • event
)
private

Defined in src/vortex/client.js:121

Message event handler

Parameters:

  • event Object

    DOMEvent

_onOpen

(
  • event
)
private

Defined in src/vortex/client.js:76

Open event handler

Parameters:

  • event Object

    DOMEvent

connect

()

Defined in src/vortex/client.js:166

Connect

disconnect

()

Defined in src/vortex/client.js:176

Disconnect

isConnected

() Boolean

Defined in src/vortex/client.js:187

Returns the connection status

Returns:

Boolean: True when a connection is open

Properties

_browser

VortexBrowser private

Defined in src/vortex/client.js:41

Crossbrowser library

_config

Object private

Defined in src/vortex/client.js:12

Configuration object

_webSocket

VortexWebSocket private

Defined in src/vortex/client.js:32

WebSocket interface