Mobilizing.js

API Documentation

for 0.0.1
Show:

PubSub Class

Defined in: src/js/Mobilizing/net/PubSub.js:31

PubSub is a publish-subscribe messaging system based on socket.io It allows simple socket communication between different clients An runing instance of MobilizingServer is required to make this work

Constructor

PubSub

(
  • params
)

Defined in src/js/Mobilizing/net/PubSub.js:31

Parameters:

  • params Object

    The parameters object

    • [url=""] String optional

      The URL of the server on which the MobilizingServer instance is running

    • [autoConnect=true] Boolean optional

      Whether the connection should be automatically opened

Example:

//TODO

Methods

close

()

Defined in src/js/Mobilizing/net/PubSub.js:102

Close the socket connection

getID

()

Defined in src/js/Mobilizing/net/PubSub.js:176

Get the socket id

open

(
  • url
)

Defined in src/js/Mobilizing/net/PubSub.js:60

Open the socket connection

Parameters:

  • url String

    URL of the server on which the MobilizingServer instance is running

publish

(
  • channel
  • message
)

Defined in src/js/Mobilizing/net/PubSub.js:115

Publish a message to a specific channel

Parameters:

  • channel String

    The channel on which to publish the message

  • message Mixed

    The message to publish

subscribe

(
  • channel
  • callback
)

Defined in src/js/Mobilizing/net/PubSub.js:128

Subscribe for messages from a specific channel

Parameters:

  • channel String

    The channel on which to subscribe

  • callback Function

    The callback to call when a message is received on the channel

unsubscribe

(
  • channel
  • [callback]
)

Defined in src/js/Mobilizing/net/PubSub.js:148

Unsubscribe for messages from a specific channel

Parameters:

  • channel String

    The channel from which to unsubscribe

  • [callback] Function optional

    The callback to remove, all callbacks will be removed if unspecified

Events

connect

Defined in src/js/Mobilizing/net/PubSub.js:4

Fired when the client successfully connects to the server

connect_timeout

Defined in src/js/Mobilizing/net/PubSub.js:22

Fired when a connection times out

disconnect

Defined in src/js/Mobilizing/net/PubSub.js:10

Fired when the client disconnects from the server

error

Defined in src/js/Mobilizing/net/PubSub.js:16

Fired when a connection error occurs