routeros-api
Version:
Mikrotik Routerboard RouterOS API for NodeJS
171 lines • 9.51 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Channel = void 0;
const events_1 = require("events");
const RosException_1 = require("./RosException");
const debug = require("debug");
const info = debug('routeros-api:channel:info');
const error = debug('routeros-api:channel:error');
/**
* Channel class is responsible for generating
* ids for the channels and writing over
* the ids generated, while listening for
* their responses
*/
class Channel extends events_1.EventEmitter {
/**
* Constructor
*
* @param {Connector} connector
*/
constructor(connector) {
super();
/**
* Data received related to the channel
*/
this.data = [];
/**
* If received a trap instead of a positive response
*/
this.trapped = false;
/**
* If is streaming content
*/
this.streaming = false;
this.id = Math.random().toString(36).substring(3);
this.connector = connector;
this.once('unknown', this.onUnknown.bind(this));
}
/**
* Get the id of the channel
*
* @returns {string}
*/
get Id() {
return this.id;
}
/**
* Get the connector used in the channel
*
* @returns {Connector}
*/
get Connector() {
return this.connector;
}
/**
* Organize the data to be written over the socket with the id
* generated. Adds a reader to the id provided, so we wait for
* the data.
*
* @param {Array} params
* @returns {Promise}
*/
write(params, isStream = false, returnPromise = true) {
this.streaming = isStream;
params.push('.tag=' + this.id);
if (returnPromise) {
this.on('data', (packet) => this.data.push(packet));
return new Promise((resolve, reject) => {
this.once('done', (data) => resolve(data));
this.once('trap', (data) => reject(new Error(data.message)));
this.readAndWrite(params);
});
}
this.readAndWrite(params);
return;
}
/**
* Closes the channel, algo asking for
* the connector to remove the reader.
* If streaming, not forcing will only stop
* the reader, not the listeners of the events
*
* @param {boolean} force - force closing by removing all listeners
*/
close(force = false) {
this.emit('close');
if (!this.streaming || force) {
this.removeAllListeners();
}
this.connector.stopRead(this.id);
}
/**
* Register the reader for the tag and write the params over
* the socket
*
* @param {Array} params
*/
readAndWrite(params) {
this.connector.read(this.id, (packet) => this.processPacket(packet));
this.connector.write(params);
}
/**
* Process the data packet received to
* figure out the answer to give to the
* channel listener, either if it's just
* the data we were expecting or if
* a trap was given.
*
* @param {Array} packet
*/
processPacket(packet) {
const reply = packet.shift();
info('Processing reply %s with data %o', reply, packet);
const parsed = this.parsePacket(packet);
if (reply === '!trap') {
this.trapped = true;
this.emit('trap', parsed);
return;
}
if (packet.length > 0 && !this.streaming)
this.emit('data', parsed);
switch (reply) {
case '!re':
if (this.streaming)
this.emit('stream', parsed);
break;
case '!empty':
return;
break;
case '!done':
if (!this.trapped)
this.emit('done', this.data);
this.close();
break;
default:
this.emit('unknown', reply);
this.close();
break;
}
}
/**
* Parse the packet line, separating the key from the data.
* Ex: transform '=interface=ether2' into object {interface:'ether2'}
*
* @param {Array} packet
* @return {Object}
*/
parsePacket(packet) {
const obj = {};
for (const line of packet) {
const linePair = line.split('=');
linePair.shift(); // remove empty index
obj[linePair.shift()] = linePair.join('=');
}
info('Parsed line, got %o as result', obj);
return obj;
}
/**
* Waits for the unknown event.
* It shouldn't happen, but if it does, throws the error and
* stops the channel
*
* @param {string} reply
* @returns {function}
*/
onUnknown(reply) {
throw new RosException_1.RosException('UNKNOWNREPLY', { reply: reply });
}
}
exports.Channel = Channel;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ2hhbm5lbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9DaGFubmVsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLG1DQUFzQztBQUV0QyxpREFBOEM7QUFDOUMsK0JBQStCO0FBRy9CLE1BQU0sSUFBSSxHQUFHLEtBQUssQ0FBQywyQkFBMkIsQ0FBQyxDQUFDO0FBQ2hELE1BQU0sS0FBSyxHQUFHLEtBQUssQ0FBQyw0QkFBNEIsQ0FBQyxDQUFDO0FBRWxEOzs7OztHQUtHO0FBQ0gsTUFBYSxPQUFRLFNBQVEscUJBQVk7SUEwQnJDOzs7O09BSUc7SUFDSCxZQUFZLFNBQW9CO1FBQzVCLEtBQUssRUFBRSxDQUFDO1FBckJaOztXQUVHO1FBQ0ssU0FBSSxHQUFVLEVBQUUsQ0FBQztRQUV6Qjs7V0FFRztRQUNLLFlBQU8sR0FBWSxLQUFLLENBQUM7UUFFakM7O1dBRUc7UUFDSyxjQUFTLEdBQVksS0FBSyxDQUFDO1FBUy9CLElBQUksQ0FBQyxFQUFFLEdBQUcsSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDbEQsSUFBSSxDQUFDLFNBQVMsR0FBRyxTQUFTLENBQUM7UUFDM0IsSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLEVBQUUsSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztJQUNwRCxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILElBQUksRUFBRTtRQUNGLE9BQU8sSUFBSSxDQUFDLEVBQUUsQ0FBQztJQUNuQixDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILElBQUksU0FBUztRQUNULE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQztJQUMxQixDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNJLEtBQUssQ0FDUixNQUFnQixFQUNoQixRQUFRLEdBQUcsS0FBSyxFQUNoQixhQUFhLEdBQUcsSUFBSTtRQUVwQixJQUFJLENBQUMsU0FBUyxHQUFHLFFBQVEsQ0FBQztRQUUxQixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sR0FBRyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUM7UUFFL0IsSUFBSSxhQUFhLEVBQUU7WUFDZixJQUFJLENBQUMsRUFBRSxDQUFDLE1BQU0sRUFBRSxDQUFDLE1BQWMsRUFBRSxFQUFFLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQztZQUU1RCxPQUFPLElBQUksT0FBTyxDQUFDLENBQUMsT0FBTyxFQUFFLE1BQU0sRUFBRSxFQUFFO2dCQUNuQyxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7Z0JBQzNDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxNQUFNLENBQUMsSUFBSSxLQUFLLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQztnQkFFN0QsSUFBSSxDQUFDLFlBQVksQ0FBQyxNQUFNLENBQUMsQ0FBQztZQUM5QixDQUFDLENBQUMsQ0FBQztTQUNOO1FBQ0QsSUFBSSxDQUFDLFlBQVksQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUMxQixPQUFPO0lBQ1gsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDSSxLQUFLLENBQUMsS0FBSyxHQUFHLEtBQUs7UUFDdEIsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUNuQixJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsSUFBSSxLQUFLLEVBQUU7WUFDMUIsSUFBSSxDQUFDLGtCQUFrQixFQUFFLENBQUM7U0FDN0I7UUFDRCxJQUFJLENBQUMsU0FBUyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUM7SUFDckMsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0ssWUFBWSxDQUFDLE1BQWdCO1FBQ2pDLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLEVBQUUsQ0FBQyxNQUFnQixFQUFFLEVBQUUsQ0FDOUMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxNQUFNLENBQUMsQ0FDN0IsQ0FBQztRQUNGLElBQUksQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBQ2pDLENBQUM7SUFFRDs7Ozs7Ozs7T0FRRztJQUNLLGFBQWEsQ0FBQyxNQUFnQjtRQUNsQyxNQUFNLEtBQUssR0FBRyxNQUFNLENBQUMsS0FBSyxFQUFFLENBQUM7UUFFN0IsSUFBSSxDQUFDLGtDQUFrQyxFQUFFLEtBQUssRUFBRSxNQUFNLENBQUMsQ0FBQztRQUV4RCxNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBRXhDLElBQUksS0FBSyxLQUFLLE9BQU8sRUFBRTtZQUNuQixJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQztZQUNwQixJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsQ0FBQztZQUMxQixPQUFPO1NBQ1Y7UUFFRCxJQUFJLE1BQU0sQ0FBQyxNQUFNLEdBQUcsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVM7WUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsQ0FBQztRQUVwRSxRQUFRLEtBQUssRUFBRTtZQUNYLEtBQUssS0FBSztnQkFDTixJQUFJLElBQUksQ0FBQyxTQUFTO29CQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxFQUFFLE1BQU0sQ0FBQyxDQUFDO2dCQUNoRCxNQUFNO1lBQ1YsS0FBSyxRQUFRO2dCQUNULE9BQU87Z0JBQ1AsTUFBTTtZQUNWLEtBQUssT0FBTztnQkFDUixJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU87b0JBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO2dCQUNoRCxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7Z0JBQ2IsTUFBTTtZQUNWO2dCQUNJLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFFLEtBQUssQ0FBQyxDQUFDO2dCQUM1QixJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7Z0JBQ2IsTUFBTTtTQUNiO0lBQ0wsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNLLFdBQVcsQ0FBQyxNQUFnQjtRQUNoQyxNQUFNLEdBQUcsR0FBRyxFQUFFLENBQUM7UUFDZixLQUFLLE1BQU0sSUFBSSxJQUFJLE1BQU0sRUFBRTtZQUN2QixNQUFNLFFBQVEsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1lBQ2pDLFFBQVEsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxDQUFDLHFCQUFxQjtZQUN2QyxHQUFHLENBQUMsUUFBUSxDQUFDLEtBQUssRUFBRSxDQUFDLEdBQUcsUUFBUSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztTQUM5QztRQUNELElBQUksQ0FBQywrQkFBK0IsRUFBRSxHQUFHLENBQUMsQ0FBQztRQUMzQyxPQUFPLEdBQUcsQ0FBQztJQUNmLENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0ssU0FBUyxDQUFDLEtBQWE7UUFDM0IsTUFBTSxJQUFJLDJCQUFZLENBQUMsY0FBYyxFQUFFLEVBQUUsS0FBSyxFQUFFLEtBQUssRUFBRSxDQUFDLENBQUM7SUFDN0QsQ0FBQztDQUNKO0FBM0xELDBCQTJMQyJ9