Table Of Contents

Flush and Disable Peer to Peer Stream Multimode Function (Timeout) (G Dataflow)

Version:
    Last Modified: August 28, 2017

    Immediately flushes data from the writer and disables the stream. In this mode, you specify an amount of time to wait for the flush to complete.

    Flushing the writer prevents the writer from accepting new data and sends all existing data in the writer to the stream.

    If you do not want to flush the writer before disabling the stream, use Disable Peer to Peer Stream.

    connector_pane_image
    datatype_icon

    session in

    A reference to the stream.

    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

    flush timeout

    The amount of time, in milliseconds, to wait for the function to complete the flush of the writer.

    If the flush does not complete within the time you specify in flush timeout, the function disables the stream and any data remaining in the writer is lost.

    Specifying an Indefinite Timeout

    To wait indefinitely, set flush timeout to -1. Alternately, you can use Flush and Disable Peer to Peer Stream (No Timeout) to wait indefinitely.

    datatype_icon

    session out

    A reference to the stream.

    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.

    Specifying a Timeout

    This function waits until the flush is complete or the time you specify in flush timeout is exceeded. If the function does not time out, the reader receives all data from the writer before the stream transitions to the Disabled state. If the function does time out, you lose any data remaining on the writer side of the stream. If this function times out, verify that the value for flush timeout is appropriate for the number of elements you expect to flush and that the reader continues to read data until the stream is empty.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: Not supported

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


    Recently Viewed Topics