Interface: NodeInterface

hyrrokkin_engine.NodeInterface

An interface describing methods that nodes should implement
Construct an instance of this node
Source:

Methods

(async) close_client(client)

Called when a client is closed
Parameters:
Name Type Description
client hyrrokkin_engine.ClientInterface an instance providing methods to send and receive messages
Source:

(async) load() → {Promise.<void>}

Called after construction. Load any resources associated with this Node
Source:
Returns:
Type
Promise.<void>

(async) open_client(client)

Called when a client is opened
Parameters:
Name Type Description
client hyrrokkin_engine.ClientInterface an instance providing methods to send and receive messages
Source:

(async) remove()

Called when the node is removed
Source:

(async) reset_run()

Implement this to be notified when a call to the run method is pending.
Source:

(async) run(inputs) → {Promise.<object>}

Called to run the node, reading inputs and returning outputs
Parameters:
Name Type Description
inputs object 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
Source:
Returns:
an object containing output values where the key is an output port name
Type
Promise.<object>