Writes an element to a Stream channel. The endpoint waits if the channel is full.


icon

Inputs/Outputs

  • ci32.png timeout in ms (-1)

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

  • cbool.png element valid? (T)

    element valid? specifies whether the element is valid. If TRUE, the endpoint records the element valid? flag. If FALSE, the endpoint ignores the value of element. The endpoint does nothing if both element valid? and last element? are FALSE. The default is TRUE.

  • ci16.png element

    element specifies the data to write to the channel.

  • cbool.png last element? (F)

    last element? specifies whether this is the last element that the endpoint writes to the channel. The default is FALSE. If TRUE, the endpoint marks the channel as closed and ignores further calls to write. The reader endpoint can continue reading data until the last element? output of the reader endpoint returns TRUE.

  • ci32.png size (unlimited)

    size specifies the maximum number of elements that can be buffered in the channel. The default is unlimited. The channel size is initialized on the first call to the writer endpoint, after which the endpoint ignores the size input.

  • ibool.png timed out?

    timed out? returns TRUE if the amount of time specified by timeout in ms elapses before the endpoint writes the data specified in element to the channel.

  • ii32.png count

    count returns the number of elements in the channel after this endpoint updates the channel. Use this output to monitor the relative writing and reading speed of the channel endpoints and make adjustments, if necessary.

  • iqueuern.png channel

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

  • FPGA Module Details

    The following details apply when you use this object in an FPGA VI.

    Note The following details are subject to change with each version of the LabVIEW FPGA Module.
    Single-Cycle Timed Loop Not supported.
    Usage

    When used on FPGA, the size input has no default value and must be connected to a constant with a value greater than zero.

    For arrays, this endpoint supports only fixed-sized one-dimensional arrays of supported data types. This endpoint does not support variable-sized arrays even if the array resolves to a single size at compile time.

    This endpoint does not support LabVIEW classes.

    If you use this endpoint with the single-precision floating-point data type, refer to the following topics for resource use, latency, and single-cycle Timed Loop support implications.
    Resources This endpoint requires FPGA resources proportional to the number you specified in size.
    Notes A channel terminal of a non-reentrant subVI can be connected to only one channel. If a non-reentrant subVI is called from multiple locations, the channel wires connected to a given terminal must resolve to the same channel at compile time.