123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275 |
- /**
- * Module dependencies.
- */
- var Socket = require('./socket');
- var Emitter = require('events').EventEmitter;
- var parser = require('socket.io-parser');
- var debug = require('debug')('socket.io:namespace');
- /**
- * Module exports.
- */
- module.exports = exports = Namespace;
- /**
- * Blacklisted events.
- */
- exports.events = [
- 'connect', // for symmetry with client
- 'connection',
- 'newListener'
- ];
- /**
- * Flags.
- */
- exports.flags = [
- 'json',
- 'volatile',
- 'local'
- ];
- /**
- * `EventEmitter#emit` reference.
- */
- var emit = Emitter.prototype.emit;
- /**
- * Namespace constructor.
- *
- * @param {Server} server instance
- * @param {Socket} name
- * @api private
- */
- function Namespace(server, name){
- this.name = name;
- this.server = server;
- this.sockets = {};
- this.connected = {};
- this.fns = [];
- this.ids = 0;
- this.rooms = [];
- this.flags = {};
- this.initAdapter();
- }
- /**
- * Inherits from `EventEmitter`.
- */
- Namespace.prototype.__proto__ = Emitter.prototype;
- /**
- * Apply flags from `Socket`.
- */
- exports.flags.forEach(function(flag){
- Object.defineProperty(Namespace.prototype, flag, {
- get: function() {
- this.flags[flag] = true;
- return this;
- }
- });
- });
- /**
- * Initializes the `Adapter` for this nsp.
- * Run upon changing adapter by `Server#adapter`
- * in addition to the constructor.
- *
- * @api private
- */
- Namespace.prototype.initAdapter = function(){
- this.adapter = new (this.server.adapter())(this);
- };
- /**
- * Sets up namespace middleware.
- *
- * @return {Namespace} self
- * @api public
- */
- Namespace.prototype.use = function(fn){
- if (this.server.eio) {
- debug('removing initial packet');
- delete this.server.eio.initialPacket;
- }
- this.fns.push(fn);
- return this;
- };
- /**
- * Executes the middleware for an incoming client.
- *
- * @param {Socket} socket that will get added
- * @param {Function} fn last fn call in the middleware
- * @api private
- */
- Namespace.prototype.run = function(socket, fn){
- var fns = this.fns.slice(0);
- if (!fns.length) return fn(null);
- function run(i){
- fns[i](socket, function(err){
- // upon error, short-circuit
- if (err) return fn(err);
- // if no middleware left, summon callback
- if (!fns[i + 1]) return fn(null);
- // go on to next
- run(i + 1);
- });
- }
- run(0);
- };
- /**
- * Targets a room when emitting.
- *
- * @param {String} name
- * @return {Namespace} self
- * @api public
- */
- Namespace.prototype.to =
- Namespace.prototype.in = function(name){
- if (!~this.rooms.indexOf(name)) this.rooms.push(name);
- return this;
- };
- /**
- * Adds a new client.
- *
- * @return {Socket}
- * @api private
- */
- Namespace.prototype.add = function(client, query, fn){
- debug('adding socket to nsp %s', this.name);
- var socket = new Socket(this, client, query);
- var self = this;
- this.run(socket, function(err){
- process.nextTick(function(){
- if ('open' == client.conn.readyState) {
- if (err) return socket.error(err.data || err.message);
- // track socket
- self.sockets[socket.id] = socket;
- // it's paramount that the internal `onconnect` logic
- // fires before user-set events to prevent state order
- // violations (such as a disconnection before the connection
- // logic is complete)
- socket.onconnect();
- if (fn) fn();
- // fire user-set events
- self.emit('connect', socket);
- self.emit('connection', socket);
- } else {
- debug('next called after client was closed - ignoring socket');
- }
- });
- });
- return socket;
- };
- /**
- * Removes a client. Called by each `Socket`.
- *
- * @api private
- */
- Namespace.prototype.remove = function(socket){
- if (this.sockets.hasOwnProperty(socket.id)) {
- delete this.sockets[socket.id];
- } else {
- debug('ignoring remove for %s', socket.id);
- }
- };
- /**
- * Emits to all clients.
- *
- * @return {Namespace} self
- * @api public
- */
- Namespace.prototype.emit = function(ev){
- if (~exports.events.indexOf(ev)) {
- emit.apply(this, arguments);
- } else {
- // set up packet object
- var args = Array.prototype.slice.call(arguments);
- var packet = { type: parser.EVENT, data: args };
- if ('function' == typeof args[args.length - 1]) {
- throw new Error('Callbacks are not supported when broadcasting');
- }
- this.adapter.broadcast(packet, {
- rooms: this.rooms,
- flags: this.flags
- });
- this.rooms = [];
- this.flags = {};
- }
- return this;
- };
- /**
- * Sends a `message` event to all clients.
- *
- * @return {Namespace} self
- * @api public
- */
- Namespace.prototype.send =
- Namespace.prototype.write = function(){
- var args = Array.prototype.slice.call(arguments);
- args.unshift('message');
- this.emit.apply(this, args);
- return this;
- };
- /**
- * Gets a list of clients.
- *
- * @return {Namespace} self
- * @api public
- */
- Namespace.prototype.clients = function(fn){
- this.adapter.clients(this.rooms, fn);
- // reset rooms for scenario:
- // .in('room').clients() (GH-1978)
- this.rooms = [];
- return this;
- };
- /**
- * Sets the compress flag.
- *
- * @param {Boolean} compress if `true`, compresses the sending data
- * @return {Socket} self
- * @api public
- */
- Namespace.prototype.compress = function(compress){
- this.flags.compress = compress;
- return this;
- };
|