expresser

<!DOCTYPE html> <html> <head> <title>sockets.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="public/stylesheets/normalize.css" /> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div class="container"> <div class="page"> <div class="header"> <h1>sockets.coffee</h1> <div class="toc"> <h3>Table of Contents</h3> <ol> <li> <a class="source" href="index.html"> index.coffee </a> </li> <li> <a class="source" href="app.html"> app.coffee </a> </li> <li> <a class="source" href="cron.html"> cron.coffee </a> </li> <li> <a class="source" href="database.html"> database.coffee </a> </li> <li> <a class="source" href="downloader.html"> downloader.coffee </a> </li> <li> <a class="source" href="events.html"> events.coffee </a> </li> <li> <a class="source" href="firewall.html"> firewall.coffee </a> </li> <li> <a class="source" href="imaging.html"> imaging.coffee </a> </li> <li> <a class="source" href="logger.html"> logger.coffee </a> </li> <li> <a class="source" href="mailer.html"> mailer.coffee </a> </li> <li> <a class="source" href="settings.html"> settings.coffee </a> </li> <li> <a class="source" href="sockets.html"> sockets.coffee </a> </li> <li> <a class="source" href="utils.html"> utils.coffee </a> </li> </ol> </div> </div> <h2 id="expresser-sockets">EXPRESSER SOCKETS</h2> Handles sockets communication using the module Socket.IO. ATTENTION! The Sockets module is started automatically by the App module. If you wish to disable it, set <code>Settings.sockets.enabled</code> to false.  <div class='highlight'><pre>class Sockets lodash = require "lodash" logger = require "./logger.coffee" settings = require "./settings.coffee"</pre></div> @property [Array] Holds a list of current event listeners. <div class='highlight'><pre> currentListeners: null</pre></div> @property [Socket.IO Object] Exposes Socket.IO object to external modules. <div class='highlight'><pre> io: null</pre></div> <h2 id="init">INIT</h2> Bind the Socket.IO object to the Express app. This will also set the counter to increase / decrease when users connects or disconnects from the app. @param [Object] options Sockets init options. @option options [Object] server The Express server object to bind to. <div class='highlight'><pre> init: (options) => options = {server: options} if not options.server? @currentListeners = [] if not options.server? logger.error "Sockets.init", "App server is invalid. Abort!" return @io = require("socket.io") options.server</pre></div> Listen to user connection count updates. <div class='highlight'><pre> @io.sockets.on "connection", (socket) => @io.emit "connection-count", @getConnectionCount() socket.on "disconnect", @onDisconnect</pre></div> Bind all current event listeners. <div class='highlight'><pre> for listener in @currentListeners socket.on listener.key, listener.callback if listener?</pre></div> <h2 id="events">EVENTS</h2> Emit the specified key and data to clients. @param [String] key The event key. @param [Object] data The JSON data to be sent out to clients. <div class='highlight'><pre> emit: (key, data) => if @io? @io.emit key, data logger.debug "Sockets.emit", key, JSON.stringify(data).length + " bytes" else logger.debug "Sockets.emit", key, "Sockets not initiated yet, abort!"</pre></div> Listen to a specific event. If <code>onlyNewClients</code> is true then it won’t listen to that particular event from currently connected clients. @param [String] key The event key. @param [Method] callback The callback to be called when key is triggered. @param [Boolean] onlyNewClients Optional, if true, listen to event only from new clients. <div class='highlight'><pre> listenTo: (key, callback, onlyNewClients) => return if not callback? onlyNewClients = false if not onlyNewClients? @currentListeners.push {key: key, callback: callback} if not onlyNewClients for key, socket of @io.sockets.connected socket.on key, callback logger.debug "Sockets.listenTo", key</pre></div> Stops listening to the specified event key. @param [String] key The event key. @param [Object] callback The callback to stop triggering. <div class='highlight'><pre> stopListening: (key, callback) => for socketKey, socket of @io.sockets.connected if callback? socket.removeListener key, callback else socket.removeAllListeners key</pre></div> Remove binding from the currentListeners collection. <div class='highlight'><pre> for listener in @currentListeners if listener.key is key and (listener.callback is callback or not callback?) listener = null logger.debug "Sockets.stopListening", key</pre></div> Remove invalid and expired event listeners. <div class='highlight'><pre> compact: => @currentListeners = lodash.compact @currentListeners</pre></div> <h2 id="helpers">HELPERS</h2> Get how many users are currenly connected to the app. <div class='highlight'><pre> getConnectionCount: => return Object.keys(@io.sockets.connected).length</pre></div> When user disconnects, emit an event with the new connection count to all clients. <div class='highlight'><pre> onDisconnect: => count = @getConnectionCount() logger.debug "Sockets.onDisconnect", "New count: #{count}."</pre></div> <h2 id="singleton-implementation">Singleton implementation</h2> <div class='highlight'><pre>Sockets.getInstance = -> @instance = new Sockets() if not @instance? return @instance module.exports = exports = Sockets.getInstance()</pre></div> <div class="fleur">h</div> </div> </div> </body> </html>