rpc-websocketserver
Version:
Simple rpc websocket server, wrapping the very popular 'ws' library. Register your RPCs with convenient decorators.
162 lines • 7.59 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.WebSocketServer = void 0;
var ws_1 = __importDefault(require("ws"));
/**
* Abstract WebSocketServer class. Describes a namespace once inherited.
* Wraps the ws lib WebSocket.Server. Includes convenience methods to interact with clients.
*
* @abstract
* @example
* class NamespaceA extends WebSocketServer {
* constructor(messageHandler: MessageHandler, options: WebSocket.ServerOptions) {
* super(messageHandler, options);
* }
*
* `@register()`
* sum(@param('a') a: number, @param('b') b: number) {
* return a + b;
* }
* }
*/
var WebSocketServer = /** @class */ (function () {
/**
* @param messageHandler {MessageHandler} - MessageHandler instance
* @param options {WebSocket.ServerOptions} - ws server options
* @protected
*/
function WebSocketServer(messageHandler, options) {
var _this = this;
this.wss = new ws_1.default.Server(options);
this.wss.addListener('connection', function (ws) { return _this._onConnection(ws); });
this._namespaceMethods = this._initNamespaceMethods();
this._messageHandler = messageHandler;
}
/**
* Returns all registered methods of namespace
*
* @returns {Map<string, Method>} - Map of all registered methods in namespace with method name as key
*/
WebSocketServer.prototype.getMethods = function () {
return this._namespaceMethods;
};
/**
* Sends passed data to all connected clients
*
* @param {WebSocket.Data} data - data to be sent to clients
*/
WebSocketServer.prototype.broadcastMessage = function (data) {
var _this = this;
this.wss.clients.forEach(function (client) { return _this._sendMessage(client, data); });
};
/**
* Sends passed data to passed websocket
*
* @param ws {WebSocket} - client to receive data
* @param data {WebSocket.Data} - data to be sent to client
* @protected
*/
WebSocketServer.prototype._sendMessage = function (ws, data) {
if (ws.readyState === ws_1.default.OPEN)
ws.send(data);
};
/**
* Convenience method to set listeners on websocket connection
*
* @param ws {WebSocket} - websocket/client that established a connection
* @protected
*/
WebSocketServer.prototype._onConnection = function (ws) {
var _this = this;
ws.on('message', function (message) { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
return [2 /*return*/, this._onMessage(ws, message)];
}); }); });
};
/**
* On message listener to handle and process incoming messages
*
* @param ws {WebSocket} - websocket/client that sent the message
* @param message {WebSocket.Data} - data received from the client
* @protected
* @returns {Promise<void>}
*/
WebSocketServer.prototype._onMessage = function (ws, message) {
return __awaiter(this, void 0, void 0, function () {
var handlerResult, res, err_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
handlerResult = this._messageHandler.handle(message, this._namespaceMethods);
return [4 /*yield*/, this._messageHandler.process(this, handlerResult)];
case 1:
res = _a.sent();
if (res)
this._sendMessage(ws, res);
return [3 /*break*/, 3];
case 2:
err_1 = _a.sent();
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
});
};
/**
* Convenience method to initialize namespace specific methods instance variable from all registered methods
*
* @returns {Map<string, Method>} - Map of all registered methods in namespace with method name as key
*/
WebSocketServer.prototype._initNamespaceMethods = function () {
var namespaceMethods = new Map();
var thisNamespace = Object.getPrototypeOf(this).constructor.name;
WebSocketServer.methods.forEach(function (method) {
if (thisNamespace === method.namespace)
namespaceMethods.set(method.name, method);
});
return namespaceMethods;
};
WebSocketServer.methods = new Set();
return WebSocketServer;
}());
exports.WebSocketServer = WebSocketServer;
//# sourceMappingURL=websocket-server.js.map