You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
252 lines
6.9 KiB
252 lines
6.9 KiB
4 years ago
|
"use strict";
|
||
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
||
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
||
|
};
|
||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||
|
exports.Namespace = void 0;
|
||
|
const socket_1 = require("./socket");
|
||
|
const events_1 = require("events");
|
||
|
const socket_io_parser_1 = require("socket.io-parser");
|
||
|
const debug_1 = __importDefault(require("debug"));
|
||
|
const debug = debug_1.default("socket.io:namespace");
|
||
|
class Namespace extends events_1.EventEmitter {
|
||
|
/**
|
||
|
* Namespace constructor.
|
||
|
*
|
||
|
* @param {Server} server instance
|
||
|
* @param {string} name
|
||
|
*/
|
||
|
constructor(server, name) {
|
||
|
super();
|
||
|
this.sockets = new Map();
|
||
|
/** @private */
|
||
|
this._fns = [];
|
||
|
/** @private */
|
||
|
this._rooms = new Set();
|
||
|
/** @private */
|
||
|
this._flags = {};
|
||
|
/** @private */
|
||
|
this._ids = 0;
|
||
|
this.server = server;
|
||
|
this.name = name;
|
||
|
this._initAdapter();
|
||
|
}
|
||
|
/**
|
||
|
* Initializes the `Adapter` for this nsp.
|
||
|
* Run upon changing adapter by `Server#adapter`
|
||
|
* in addition to the constructor.
|
||
|
*
|
||
|
* @private
|
||
|
*/
|
||
|
_initAdapter() {
|
||
|
this.adapter = new (this.server.adapter())(this);
|
||
|
}
|
||
|
/**
|
||
|
* Sets up namespace middleware.
|
||
|
*
|
||
|
* @return {Namespace} self
|
||
|
* @public
|
||
|
*/
|
||
|
use(fn) {
|
||
|
this._fns.push(fn);
|
||
|
return this;
|
||
|
}
|
||
|
/**
|
||
|
* Executes the middleware for an incoming client.
|
||
|
*
|
||
|
* @param {Socket} socket - the socket that will get added
|
||
|
* @param {Function} fn - last fn call in the middleware
|
||
|
* @private
|
||
|
*/
|
||
|
run(socket, fn) {
|
||
|
const 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
|
||
|
* @public
|
||
|
*/
|
||
|
to(name) {
|
||
|
this._rooms.add(name);
|
||
|
return this;
|
||
|
}
|
||
|
/**
|
||
|
* Targets a room when emitting.
|
||
|
*
|
||
|
* @param {String} name
|
||
|
* @return {Namespace} self
|
||
|
* @public
|
||
|
*/
|
||
|
in(name) {
|
||
|
this._rooms.add(name);
|
||
|
return this;
|
||
|
}
|
||
|
/**
|
||
|
* Adds a new client.
|
||
|
*
|
||
|
* @return {Socket}
|
||
|
* @private
|
||
|
*/
|
||
|
_add(client, query, fn) {
|
||
|
debug("adding socket to nsp %s", this.name);
|
||
|
const socket = new socket_1.Socket(this, client, query);
|
||
|
this.run(socket, err => {
|
||
|
process.nextTick(() => {
|
||
|
if ("open" == client.conn.readyState) {
|
||
|
if (err)
|
||
|
return socket._error({
|
||
|
message: err.message,
|
||
|
data: err.data
|
||
|
});
|
||
|
// track socket
|
||
|
this.sockets.set(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
|
||
|
super.emit("connect", socket);
|
||
|
super.emit("connection", socket);
|
||
|
}
|
||
|
else {
|
||
|
debug("next called after client was closed - ignoring socket");
|
||
|
}
|
||
|
});
|
||
|
});
|
||
|
return socket;
|
||
|
}
|
||
|
/**
|
||
|
* Removes a client. Called by each `Socket`.
|
||
|
*
|
||
|
* @private
|
||
|
*/
|
||
|
_remove(socket) {
|
||
|
if (this.sockets.has(socket.id)) {
|
||
|
this.sockets.delete(socket.id);
|
||
|
}
|
||
|
else {
|
||
|
debug("ignoring remove for %s", socket.id);
|
||
|
}
|
||
|
}
|
||
|
/**
|
||
|
* Emits to all clients.
|
||
|
*
|
||
|
* @return {Boolean} Always true
|
||
|
* @public
|
||
|
*/
|
||
|
emit(ev, ...args) {
|
||
|
if (socket_1.RESERVED_EVENTS.has(ev)) {
|
||
|
throw new Error(`"${ev}" is a reserved event name`);
|
||
|
}
|
||
|
// set up packet object
|
||
|
args.unshift(ev);
|
||
|
const packet = {
|
||
|
type: socket_io_parser_1.PacketType.EVENT,
|
||
|
data: args
|
||
|
};
|
||
|
if ("function" == typeof args[args.length - 1]) {
|
||
|
throw new Error("Callbacks are not supported when broadcasting");
|
||
|
}
|
||
|
const rooms = new Set(this._rooms);
|
||
|
const flags = Object.assign({}, this._flags);
|
||
|
// reset flags
|
||
|
this._rooms.clear();
|
||
|
this._flags = {};
|
||
|
this.adapter.broadcast(packet, {
|
||
|
rooms: rooms,
|
||
|
flags: flags
|
||
|
});
|
||
|
return true;
|
||
|
}
|
||
|
/**
|
||
|
* Sends a `message` event to all clients.
|
||
|
*
|
||
|
* @return {Namespace} self
|
||
|
* @public
|
||
|
*/
|
||
|
send(...args) {
|
||
|
args.unshift("message");
|
||
|
this.emit.apply(this, args);
|
||
|
return this;
|
||
|
}
|
||
|
/**
|
||
|
* Sends a `message` event to all clients.
|
||
|
*
|
||
|
* @return {Namespace} self
|
||
|
* @public
|
||
|
*/
|
||
|
write(...args) {
|
||
|
args.unshift("message");
|
||
|
this.emit.apply(this, args);
|
||
|
return this;
|
||
|
}
|
||
|
/**
|
||
|
* Gets a list of clients.
|
||
|
*
|
||
|
* @return {Namespace} self
|
||
|
* @public
|
||
|
*/
|
||
|
allSockets() {
|
||
|
if (!this.adapter) {
|
||
|
throw new Error("No adapter for this namespace, are you trying to get the list of clients of a dynamic namespace?");
|
||
|
}
|
||
|
const rooms = new Set(this._rooms);
|
||
|
this._rooms.clear();
|
||
|
return this.adapter.sockets(rooms);
|
||
|
}
|
||
|
/**
|
||
|
* Sets the compress flag.
|
||
|
*
|
||
|
* @param {Boolean} compress - if `true`, compresses the sending data
|
||
|
* @return {Namespace} self
|
||
|
* @public
|
||
|
*/
|
||
|
compress(compress) {
|
||
|
this._flags.compress = compress;
|
||
|
return this;
|
||
|
}
|
||
|
/**
|
||
|
* Sets a modifier for a subsequent event emission that the event data may be lost if the client is not ready to
|
||
|
* receive messages (because of network slowness or other issues, or because they’re connected through long polling
|
||
|
* and is in the middle of a request-response cycle).
|
||
|
*
|
||
|
* @return {Namespace} self
|
||
|
* @public
|
||
|
*/
|
||
|
get volatile() {
|
||
|
this._flags.volatile = true;
|
||
|
return this;
|
||
|
}
|
||
|
/**
|
||
|
* Sets a modifier for a subsequent event emission that the event data will only be broadcast to the current node.
|
||
|
*
|
||
|
* @return {Namespace} self
|
||
|
* @public
|
||
|
*/
|
||
|
get local() {
|
||
|
this._flags.local = true;
|
||
|
return this;
|
||
|
}
|
||
|
}
|
||
|
exports.Namespace = Namespace;
|