Stream
- Updated2025-01-28
- 1 minute(s) read
Requires: FPGA Module
Use the Stream channel to communicate homogeneous data from a single writer to a single reader. The data elements are buffered and transferred with no data loss in a first-in-first-out (FIFO) order.
Refer to the Channel Wire Endpoints Details topic for information about Timed Loop compatibility, usage, and resource considerations related to the Stream endpoints.
| Endpoint | Description |
|---|---|
| Read | Reads an element from a Stream channel. The endpoint waits if the channel is empty. |
| Read With Abort | Reads an element from a Stream channel or signals the channel to abort. This endpoint is the same as the Read endpoint except that it has an abort input and an aborted? output. You can use the abort capability of the Stream channel to close a channel abruptly, ignoring any data left in the channel buffer. You must use this endpoint together with the Write With Abort endpoint. |
| Write | Writes an element to a Stream channel. The endpoint waits if the channel is full. |
| Write With Abort | Writes an element to a Stream channel or signals the channel to abort. The endpoint waits if the channel is full. This endpoint is the same as the Write endpoint except that it has an abort input and an aborted? output. You can use the abort capability of the Stream channel to close a channel abruptly, ignoring any data left in the channel buffer. You must use this endpoint together with the Read With Abort endpoint. |