Write With Abort Endpoint

Requires: Base Development System

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.

Details  Example

	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.
	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.
	element specifies the data to write to the channel.
	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.
	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.
	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.
	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

Example

Refer to the Channel - One Element Stream.lvproj in the labview\examples\Channels\One Element Stream directory for an example of using the Write With Abort endpoint.

 Open example  Find related examples