outlet
Name | Type | Description | Optional |
---|---|---|---|
input |
? |
output from the current circuit |
yes |
An outlet
defines an inbound port on a circuit. Calls to the circuit will have a corresponding outlet on the call node itself, by the same name as the outlet
node in the circuit (MyOutletName
here). Dataflow values are delivered from the circuit through an outlet port. The input of the outlet
node is the output 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 outlet on the call, to the nodes that are connected to the outlet
node in the circuit.
Outlet ports on a call appear in the same order that the corresponding outlet
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.