Reads an element from a Real Time Stream channel.

You can drop this endpoint on the block diagram by right-clicking a Real Time Stream channel terminal or wire and selecting Create»Channel Reader»Real Time Stream»Read.


icon

Inputs/Outputs

  • cqueuern.png channel —

    channel is the channel wire that connects this endpoint to a writer endpoint.

  • cbool.png abort before read? (F) —

    abort before read? specifies whether to abort before reading the element from the channel. The default is FALSE.

  • ci32.png timeout in ms (-1) —

    timeout in ms is the time, in milliseconds, that this endpoint has to read the elements from the channel. The default value is -1, which means there is no time limit.

  • iReal_Time_Stream_lvlib_Abort_Signallvclass.png abort signal —

    abort signal is an object for aborting a Real Time channel after the read operation. You can use this object's Abort method to stop the channel. Right click the abort signal terminal and select Create Abort Node to generate the Abort function.

  • idbl.png element —

    element returns the data that this endpoint reads from the channel. This output returns the default value of the transmission data type if a timeout occurs, if the channel closes without a valid last element, or if the channel aborts.

  • ibool.png element valid? —

    element valid? returns TRUE if the element was read successfully. This output returns FALSE if a timeout occurs or if the channel aborts.

  • ibool.png done? —

    done? returns TRUE if the endpoint has read the last element or if the channel aborts on either endpoint. This output returns FALSE if a timeout occurs.

  • ibool.png timed out? —

    timed out? returns TRUE if the amount of time specified by timeout in ms elapses. If timed out? is TRUE, element valid? will be FALSE.

    • Related Information

    Write