Table Of Contents

Flush Stream (G Dataflow)

Version:
Last Modified: August 28, 2017

Transfers all data to the reader endpoint before data flow resumes. You can call this node from the writer endpoint only.

Programming Patterns

Use this node before using the Destroy Stream Endpoint node to ensure that the writer endpoint buffer is empty before you destroy it.

connector_pane_image
datatype_icon

endpoint in

Reference to the endpoint. Obtain this reference by wiring endpoint out from another network stream node, such as Flush Stream or Read Multiple Elements from Stream, to this one.

datatype_icon

wait condition

Condition under which data flow resumes.

Name Value Description
all elements read from stream 0 The data flow will resume when the Network Streams Engine transfers all data to the reader endpoint and the reader endpoint finishes reading the data.
all elements available for reading 1 The data flow will resume when the network streams engine transfers all data to the reader endpoint but before the reader endpoint finishes reading that data.

Network Stream Engine Functionality

The Network Stream Engine is the background process that asynchronously moves data from the writer endpoint to the reader endpoint and sends acknowledgment and flow control messages from the reader endpoint to the writer endpoint.

Default: all elements read from stream

datatype_icon

timeout in ms

Time, in milliseconds, that this node waits for the wait condition to complete.

Default: -1 — This node waits indefinitely.

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

endpoint out

Reference to the endpoint specified by endpoint in.

datatype_icon

timed out?

A Boolean value that indicates whether the wait condition completes within the timeout period.

True wait condition did not complete within the timeout period.
False wait condition completed within the timeout period.
datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Where This Node Can Run:

Desktop OS: Windows

FPGA: This product does not support FPGA devices

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics