Writes an element to a One Element Stream channel or signals the channel to abort. The endpoint waits if the channel is full. This endpoint is the same as the Write endpoint except that it has an abort input and an aborted? output. You can use the abort capability of the One Element Stream channel to close a channel abruptly, ignoring any data left in the channel buffer. You must use this endpoint together with the Read With Abort endpoint.

You can drop this endpoint on the block diagram by right-clicking a terminal or a wire and selecting Create»Channel Writer»One Element Stream»Write With Abort.


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.

  • csgl.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.

  • cbool.png abort —

    abort specifies whether to abort this channel. If abort is TRUE, this endpoint marks the channel as closed and ignores further calls to write. Meanwhile, the aborted? output returns TRUE on the next call of this endpoint.

  • 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.

  • iqueuern.png channel —

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

  • ibool.png aborted? —

    aborted? returns TRUE if abort occurred on this endpoint or the reader endpoints connected to the channel. If aborted? is TRUE, further calls to this endpoint will do nothing except returning aborted? TRUE again.

    • Related Information

    Read With Abort

    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

    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.
    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.

    Examples

    Refer to the following example files included with LabVIEW.

    • labview\examples\Channels\One Element Stream\Channel - One Element Stream.lvproj