CL Stream Poll

Owning Palette: Communications/Advanced

Requirements: Quanser Rapid Control Prototyping Toolkit, LabVIEW 2020 or newer, Control Design and Simulation Module

Description

The CL Stream Poll VI polls for events associated with the stream. For example, it can be used to wait until data is ready to receive or until a client connection is pending. The CL Stream Poll VI waits for one of the selected events or the timeout to occur. If one or more events occur then it returns true at the corresponding output ports. If the timeout occurs then it returns false at all the event output ports and true at the timed out terminal. If an error occurs then it is reflected at the error out terminal. The operation of this VI is not affected by the blocking mode of the stream connected to its input.

Required Inputs All required inputs must be wired. They always appear as terminals on the VI palette. They also appear in bold text in the context help window for the VI.

stream in is a reference to the stream created by the CL Stream Connect, CL Stream Accept or CL Stream Listen VI. If the stream is closed or is otherwise invalid then the negative error code `-QERR_INVALID_STREAM` is returned by the error out output.

Recommended Inputs or Dialog Box Options Recommended inputs need not to be wired. They may be selected to appear as terminals or dialog parameters, but show up as terminals by default. They appear in simple text in the context help window for the VI.

timeout is the number of seconds to wait for an event to occur. If none of the selected events occur within the timeout period then the VI returns and the timed out terminal will be true.

wait for data available to receive, enables the output, data is available to receive. This flag only guarantees that at least one byte is available in the stream buffer to receive. It does not guarantee that the CL Stream Receive will not VI unless it is only receiving a single byte. However, if messages are being sent over the stream it generally means that the entire message can be received almost immediately once the first byte arrives.

wait for space available to send, enables the output, space available to send. This flag only guarantees that at least one byte is available in the stream buffer for sending. It does not guarantee that the CL Stream Send will not VI unless it is only sending a single byte. However, if messages are being sent over the stream it generally means that the entire message can be sent almost immediately once space for one byte becomes available.

wait for space available to flush, enables the output, space available to flush. This flag only guarantees that at least one byte of the stream buffer can be flushed. It does not guarantee that the CL Stream Flush will not VI unless it is only flushing a single byte.

wait for connection to complete, enables the output, connection completed. Note that this condition may not be distinguishable from the snd or fls conditions for some streams. Refer to the help for a particular protocol for details.

wait for a client connection to be ready to accept, enables the output, connection accepted. This condition is only valid for listening streams. It guarantees that a CL Stream Accept VI will return immediately with a new client connection. Note that this condition may not be distinguishable from the rcv condition for some streams. Refer to the help for a particular protocol for details.

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.

status is TRUE if an error occurred. If status is TRUE, the VI does not perform any operations.

code is the error code number identifying an error. A value of 0 means no error, a negative value means a fatal error, and a positive value is a warning. Refer to the Quanser Error Codes for a code description.

source identifies where an error occurred. The source string is usually the name of the VI that produced the error.

Outputs

stream out is a reference to the stream. This output is merely a copy of the stream in input.

timed out returns true if none of the selected events occur within the timeout period.

data is available to receive, a value indicating whether data is available to receive. This flag only guarantees that at least one byte is available in the stream buffer to receive. It does not guarantee that the Stream Receive will not block unless it is only receiving a single byte. However, if messages are being sent over the stream it generally means that the entire message can be received almost immediately once the first byte arrives. If Wait for data available to receive is not enabled, the corresponding output will be -1.

space available to send, a value indicating whether there is space in the stream buffer to store more data for transmission. This flag only guarantees that at least one byte is available in the stream buffer for sending. It does not guarantee that the Stream Send will not block unless it is only sending a single byte. However, if messages are being sent over the stream it generally means that the entire message can be sent almost immediately once space for one byte becomes available.If Wait for space available to send is not enabled, the corresponding output will be -1.

space available to flush, a value indicating whether the data in the stream buffer can be flushed to the underlying communication channel. This flag only guarantees that at least one byte of the stream buffer can be flushed. It does not guarantee that the Stream Flush will not block unless it is only flushing a single byte. If Wait for space available to flushis not enabled, the corresponding output will be -1.

connection completed, a value indicating whether a non-blocking Stream Connect has finished making the connection. Note that this condition may not be distinguishable from the snd or fls conditions for some streams. Refer to the help for a particular protocol for details.If Wait for connection to complete is not enabled, the corresponding output will be -1.

connection accepted, a value indicating whether a client connection is pending on a listening stream. This condition is only valid for listening streams. It guarantees that a Stream Accept VI will return immediately with a new client connection. Note that this condition may not be distinguishable from the rcv condition for some streams. Refer to the help for a particular protocol for details.If Wait for a client connection to be ready to accept inputs is not enabled, the corresponding output will be -1.

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.

	status is TRUE if an error occurred. If status is TRUE, the VI does not perform any operations.
	code is the error code number identifying an error. A value of 0 means no error, a negative value means a fatal error, and a positive value is a warning. Refer to the Quanser Error Codes for a code description.
	source identifies where an error occurred. The source string is usually the name of the VI that produced the error.

Feedthrough Behaviour

All input/output pairs of this function have direct feedthrough behaviour.

Examples

RCP CL Comm Advanced Stream Example

Targets

Target	Supported	Comments
RCP Windows (64-bit) Target	Yes	Fully supported.

navigation bar