One Element Stream
- Updated2025-01-28
- 1 minute(s) read
Requires: FPGA Module
Use the One Element Stream channel exactly the way you use a Stream channel with size equal to one. Allowing only one element in the buffer makes One Element Stream channels more optimized. They execute faster and save resources compared with Stream channels.
Refer to the Channel Wire Endpoints Details topic for information about Timed Loop compatibility, usage, and resource considerations related to the One Element Stream endpoints.
| Endpoint | Description |
|---|---|
| Read | Waits to read data from a One Element Stream channel. |
| Read With Abort | Waits to read an element from a One Element 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 One Element 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 One Element Stream channel. The endpoint waits if the channel is full. |
| Write With Abort | Writes an element to a One Element 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 One Element 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. |