noflo/lib/Network.js

Flow-Based Programming environment for JavaScript

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Network = void 0;
//     NoFlo - Flow-Based Programming for JavaScript
//     (c) 2013-2018 Flowhub UG
//     (c) 2011-2012 Henri Bergius, Nemein
//     NoFlo may be freely distributed under the MIT license
const BaseNetwork_1 = require("./BaseNetwork");
const Platform_1 = require("./Platform");
/* eslint-disable
    no-param-reassign,
    import/prefer-default-export,
*/
/**
 * @typedef NetworkProcess
 * @property {string} id
 * @property {string} [componentName]
 * @property {import("./Component").Component} [component]
 */
// ## The NoFlo network coordinator
//
// NoFlo networks consist of processes connected to each other
// via sockets attached from outports to inports.
//
// The role of the network coordinator is to take a graph and
// instantiate all the necessary processes from the designated
// components, attach sockets between them, and handle the sending
// of Initial Information Packets.
class Network extends BaseNetwork_1.BaseNetwork {
    // Add a process to the network. The node will also be registered
    // with the current graph.
    /**
     * @param {import("fbp-graph/lib/Types").GraphNode} node
     * @param {Object} options
     * @returns {Promise<NetworkProcess>}
     */
    addNode(node, options, callback) {
        if (typeof options === 'function') {
            callback = options;
            options = {};
        }
        options = options || {};
        const promise = super.addNode(node, options)
            .then((process) => {
            if (!options.initial) {
                this.graph.addNode(node.id, node.component, node.metadata);
            }
            return process;
        });
        if (callback) {
            Platform_1.deprecated('Providing a callback to Network.addNode is deprecated, use Promises');
            promise.then((process) => {
                callback(null, process);
            }, callback);
        }
        return promise;
    }
    // Remove a process from the network. The node will also be removed
    // from the current graph.
    removeNode(node, callback) {
        const promise = super.removeNode(node)
            .then(() => {
            this.graph.removeNode(node.id);
            return null;
        });
        if (callback) {
            Platform_1.deprecated('Providing a callback to Network.removeNode is deprecated, use Promises');
            promise.then(() => {
                callback(null);
            }, callback);
        }
        return promise;
    }
    // Rename a process in the network. Renaming a process also modifies
    // the current graph.
    renameNode(oldId, newId, callback) {
        const promise = super.renameNode(oldId, newId)
            .then(() => {
            this.graph.renameNode(oldId, newId);
        });
        if (callback) {
            Platform_1.deprecated('Providing a callback to Network.renameNode is deprecated, use Promises');
            promise.then(() => {
                callback(null);
            }, callback);
        }
        return promise;
    }
    // Add a connection to the network. The edge will also be registered
    // with the current graph.
    addEdge(edge, options, callback) {
        if (typeof options === 'function') {
            callback = options;
            options = {};
        }
        options = options || {};
        const promise = super.addEdge(edge, options)
            .then((socket) => {
            if (!options.initial) {
                this.graph.addEdgeIndex(edge.from.node, edge.from.port, edge.from.index, edge.to.node, edge.to.port, edge.to.index, edge.metadata);
            }
            return socket;
        });
        if (callback) {
            Platform_1.deprecated('Providing a callback to Network.addEdge is deprecated, use Promises');
            promise.then((socket) => {
                callback(null, socket);
            }, callback);
        }
        return promise;
    }
    // Remove a connection from the network. The edge will also be removed
    // from the current graph.
    removeEdge(edge, callback) {
        const promise = super.removeEdge(edge)
            .then(() => {
            this.graph.removeEdge(edge.from.node, edge.from.port, edge.to.node, edge.to.port);
            return null;
        });
        if (callback) {
            Platform_1.deprecated('Providing a callback to Network.removeEdge is deprecated, use Promises');
            promise.then(() => {
                callback(null);
            }, callback);
        }
        return promise;
    }
    // Add an IIP to the network. The IIP will also be registered with the
    // current graph. If the network is running, the IIP will be sent immediately.
    addInitial(iip, options, callback) {
        if (typeof options === 'function') {
            callback = options;
            options = {};
        }
        options = options || {};
        const promise = super.addInitial(iip, options)
            .then((socket) => {
            if (!options.initial) {
                this.graph.addInitialIndex(iip.from.data, iip.to.node, iip.to.port, iip.to.index, iip.metadata);
            }
            return socket;
        });
        if (callback) {
            Platform_1.deprecated('Providing a callback to Network.addInitial is deprecated, use Promises');
            promise.then(() => {
                callback(null);
            }, callback);
        }
        return promise;
    }
    // Remove an IIP from the network. The IIP will also be removed from the
    // current graph.
    removeInitial(iip, callback) {
        const promise = super.removeInitial(iip)
            .then(() => {
            this.graph.removeInitial(iip.to.node, iip.to.port);
        });
        if (callback) {
            Platform_1.deprecated('Providing a callback to Network.removeInitial is deprecated, use Promises');
            promise.then(() => {
                callback(null);
            }, callback);
        }
        return promise;
    }
}
exports.Network = Network;