Write With Abort Endpoint

Requires: Base Development System

Adds a value to an Accumulator Tag channel or signals the channel to abort. 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 Accumulator Tag 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»Accumulator Tag»Write With Abort.

Details  

element specifies the data to add to the channel.
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.
channel is the channel wire that connects this endpoint to a reader endpoint.
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.

Write With Abort Details

Related Information

Read With Abort