Show:

Q.Socket Class

Defined in: platform/plugins/Q/web/js/Q.js:9191
Module: Q

Q.Socket class can be used to manage sockets (implemented with socket.io)
Instantiate sockets with Q.Socket.connect

Constructor

Q.Socket

(
  • params
)
private

Defined in platform/plugins/Q/web/js/Q.js:9191

Parameters:

Item Index

Methods

Events

Methods

connect

(
  • ns
  • url
  • [callback]
  • [callback2]
)
static

Defined in platform/plugins/Q/web/js/Q.js:9307

Connects a socket, and stores it in the list of connected sockets

Parameters:

  • ns String

    A socket.io namespace to use

  • url String

    The url of the socket.io node to connect to

  • [callback] Function optional

    Called after socket connects successfully. Receives Q.Socket

  • [callback2] Function optional

    Receives Q.Socket as soon as it's constructed

destroyAll

() static

Defined in platform/plugins/Q/web/js/Q.js:9391

Completely remove all sockets, and de-register events

disconnect

()

Defined in platform/plugins/Q/web/js/Q.js:9336

Disconnects a socket corresponding to a Q.Socket

disconnectAll

(
  • ns
)
static

Defined in platform/plugins/Q/web/js/Q.js:9353

Disconnects all sockets that have been connected

Parameters:

  • ns String

    Any namespace for the sockets to disconnect

get

(
  • ns
  • url
)
Q.Socket static

Defined in platform/plugins/Q/web/js/Q.js:9205

Returns a socket, if it was already connected, or returns undefined

Parameters:

  • ns String

    The socket.io namespace

  • url String

    The url where socket.io is listening. If it's empty, then returns all matching sockets.

Returns:

Q.Socket:

getAll

() Object static

Defined in platform/plugins/Q/web/js/Q.js:9224

Returns all the sockets, whether connected or not. Note that a socket really disconnects when all the namespaces disconnect.

Returns:

Object:

indexed by socket.io namespace, url

reconnectAll

() static

Defined in platform/plugins/Q/web/js/Q.js:9373

Reconnect all sockets that have been connected

Events

onConnect

Defined in platform/plugins/Q/web/js/Q.js:9456

Be notified when a socket connects and obtain a Q.Event based on the parameters

Event Payload:

  • ns String

    the namespace of the socket

  • url String

    the url of the socket

onEvent

Defined in platform/plugins/Q/web/js/Q.js:9407

Subscribe to a socket event and obtain a Q.Event based on the parameters

Event Payload:

  • ns String

    the namespace of the socket

  • url String

    the url of the socket

  • name String

    the name of the event

onEvent

Defined in platform/plugins/Q/web/js/Q.js:9471

Returns Q.Event which occurs on a message post event coming from socket.io Generic callbacks can be assigend by setting messageType to ""

Event Payload:

  • name String

    name of the event to listen for