inlet
| Name | Type | Description | Optional |
|---|---|---|---|
output |
? |
input to the current circuit |
yes |
An inlet defines an inbound port on a circuit. Calls to the circuit will have a corresponding inlet on the call node itself, by the same name as the inlet node in the circuit (MyInletName here). Dataflow values are delivered to the circuit through an inlet port. The output of the inlet node is the input to the circuit. For every call to the circuit, it is as if there is a direct connection from the nodes that are connected to the corresponding inlet on the call, to the nodes that are connected to the inlet node in the circuit.
Inlet ports on a call appear in the same order that the corresponding inlet port nodes are arranged in the circuit, vertically.
Inlets and outlets are known as dynamic ports because they carry many dataflow values over the life of the circuit. They belong to the execution phase of the circuit, if you will, as opposed to the initialization phase. Param and return ports, in contrast, belong to the initialization phase of the circuit.