Table of Contents
Owning Palette: | Not available in this version of RCP Toolkit. Please check for updates. |
Requirements: | Quanser Rapid Control Prototyping Toolkit, LabVIEW 2020 or newer |
The Stream Flush VI writes the data in the stream buffer to the underlying communication channel. The operation of this VI is affected by the blocking mode of the stream connected to its input. Streams have two modes: blocking (the default) and non-blocking. The blocking mode of the stream is determined by the Stream Connect or Stream Accept VI which created the stream. The Stream Flush VI cannot be used with streams created using the Stream Listen VI. This VI attempts to send the contents of the stream buffer over the communication channel. If an error occurs, then it returns an error code at its error out output. If the connection is closed it is considered an error condition. If the stream is blocking, then this VI waits until all the data in the buffer is sent before returning. If the stream is non-blocking, then this VI does not wait. It attempts to send all the data remaining in the stream buffer. However, if this operation would block then it returns a QERR_WOULD_BLOCK at its error out output, even if it has already sent some of the data. In this case, the Stream Poll VI may be used to determine when at least one more byte may be flushed. This VI does not support two threads calling Stream Flush or Stream Write at the same time. However, Stream Flush or Stream Write may be called by another thread at the same time as Stream Read.
stream in is a reference to the stream to be flushed. |
error in describes error conditions occurring before the VI executes. If an error has already occurred, the VI returns the value of the error in cluster in error out.
|
stream out is a reference to the stream. This output is merely a copy of the stream in input. |
|||||||
error out contains error information. If the error in cluster indicated an error, the error out cluster contains the same information. Otherwise, error out describes the error status of this VI.
|
All input/output pairs of this function have direct feedthrough behaviour.
There are currently no examples
Stream Write | ||
Stream Read |
Target |
Supported |
Comments |
---|---|---|
Yes |
Fully supported. |
Copyright © Quanser Inc. This page was generated 2021-09-24. Submit feedback to Quanser about this page.
Link to this page.