/*
Hyrrokkin - a library for building and running executable graphs
MIT License - Copyright (C) 2022-2025 Visual Topology Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy of this software
and associated documentation files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
var hyrrokkin_engine = hyrrokkin_engine || {};
/**
* An interface describing methods that nodes should implement
*
* @interface
* @type {hyrrokkin_engine.NodeInterface}
*/
hyrrokkin_engine.NodeInterface = class {
/**
* Construct an instance of this node
*
* @param {hyrrokkin_engine.NodeServiceInterface} services a service object supplying useful functionality to the node
*/
constructor(services) {
}
/**
* Called after construction. Load any resources associated with this Node
*
* @return {Promise<void>}
*/
async load() {
}
/**
* Implement this to be notified when a call to the run method is pending.
*/
async reset_run() {
}
/**
* Called to run the node, reading inputs and returning outputs
*
* @param {object} inputs an object containing input values where the key is an input port name and the value is an array of values presented by nodes connected to the port
*
* @return {Promise<object>} an object containing output values where the key is an output port name
*/
async run(inputs) {
}
/**
* Called when a client is opened
*
* @param {hyrrokkin_engine.ClientInterface} client an instance providing methods to send and receive messages
*/
async open_client(client) {
}
/**
* Called when a client is closed
*
* @param {hyrrokkin_engine.ClientInterface} client an instance providing methods to send and receive messages
*/
async close_client(client) {
}
/**
* Called when the node is removed
*/
async remove() {
}
}