Read Handshake
- Updated2023-02-17
- 2 minute(s) read
Read Handshake
Reads one element of data from a handshake item and automatically removes the data to prepare for the next transfer.
If ready for output is False during a given clock cycle, output valid returns False during that clock cycle.
Inputs/Outputs

reference in
Reference to a handshake item.

ready for output
A Boolean that determines whether downstream nodes are ready for this node to return a new value. The default is True. Use a Feedback Node to wire the ready for input output of a downstream node to this input.
| True | Downstream nodes are ready for this node to return a new value. |
| False | Downstream nodes are not ready for this node to return a new value. |

reference out
The same handshake reference wired into this node.

data
The data retrieved from the handshake item.

output valid
Boolean value that indicates whether this node computes a result that downstream nodes can use.
Wire this output to the input valid input of a downstream node to transfer data from the node to the downstream node.
| True | Downstream nodes can use the result this node computes. |
| False | This node returns an undefined value that downstream nodes cannot use.
Note This node may return different undefined values when executed in simulation mode versus when executed on hardware.
|