Skip to content

jxmono/web-sockets

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

Web Sockets

Mono module implementation for web sockets.

Documentation

Configuration Example

"webSockets": {
    "module": "github/jillix/web-sockets/MODULE_VERSION"
  , "roles": MONO_ROLES
  , "config": {
        "binds": BIND_CONFIGURATION   // optional
      , "listen": EVENT_CONFIGURATION // optional
    }
  , "operations": {
        "init": {
            "roles": MONO_ROLES
          , "params": []
        }
    }
},

Client

self.socketInit (options, callback)

Inits the socket in the page. This is called automatically!

  • options: an object containing the following fields:

    • force: if the websocket is already inited and force is true, the websocket will be reinited
    • log: log level passed to socket.io
  • callback: a function that is called when the socket it inited

self.clientEmit (options, function)

Emits an event and data to the server

  • options: an object containing

    • event: the event name
    • data: the data that goes to server side
  • callback: a function that is passed too to the emit function from socket emit function

self.clientListen (options, function)

Listen an event that comes from the server

  • options: an object containing
    • event: the event name

callback: a function that is passed too to the on function

self.serverSend (options)

Call the sendMessage from the server

  • message: an object containing
    • type (string): client, session, group, or all
    • session (session id): which clinet should recive this message; all if undefined
    • data (object)

self.serverEmitGlobal (options)

Emits a global event using M.emit()

  • options:
    • event: the event name that is emited
    • data: data to be emited

Server

The module listens for the following server events:

  • sockets.init
  • sockets.emit
  • sockets.listen
  • sockets.send

Changelog

v0.5.0

  • transferred the module to the new jxMono organization
  • updated Bind to v0.4.0, Events to v0.4.0

v0.4.1

  • Use location.host instead of location.origin (IE compatibility, #5)
  • Update to Bind v0.3.1
  • Minor syntax changes
  • New owner (@jillix)

v0.4.0

  • Updated deps

v0.3.0

  • Fixed bugs in clientEmit method
  • Fixed #3: send a refresh signal on the client
  • Fixed #2: set the debug mode (default: false)
  • Syntax changes
  • Comments
  • Additional checks for preventing errors

v0.2.2

  • Upgrade to Events v0.1.8 and Bind v0.2.1

v0.2.1

  • Emit a global event on the server side using functions from the client side.
  • Added more public functions.
  • Removed obsolete Mono operations. The only module operation is init().

v0.2.0

  • TODO

v0.1.0

  • Initial version.

About

👿 Mono module implementation for web sockets.

Resources

License

Stars

Watchers

Forks

Packages

No packages published