Read Ack With Abort Endpoint

Requires: Base Development System

Waits for an acknowledgement from a Messenger channel or signals the channel to abort. This endpoint is the same as the Read Ack endpoint except that it has an abort input and an aborted? output. You can use the abort capability of the Messenger channel to close a channel abruptly, ignoring any data left in the channel buffer. You must use this endpoint together with the Write With Abort endpoint.

You can drop this endpoint on the block diagram by right-clicking a Messenger channel terminal or wire and selecting Create»Channel Reader»Messenger»Read Ack With Abort.

Details  

timeout in ms is the time, in milliseconds, that this endpoint has to wait for acknowledgment from a message. The default value is -1, which means there is no time limit.
channel is the channel wire that connects this endpoint to a writer endpoint.
ack id specifies the ID number of a message to be acknowledged. The default is 0, which means the endpoint waits for any message to be acknowledged. If ack id is not 0, the endpoint waits for the acknowledgment from the message with the specified ID.
abort specifies whether to abort this channel. The default is FALSE. If abort is TRUE, this endpoint marks the channel as closed and ignores further calls to read. 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.
aborted? returns TRUE if abort occurred on this endpoint or the writer endpoint connected to the channel. If aborted? is TRUE, further calls to this endpoint will do nothing except returning aborted? TRUE again.

Read Ack With Abort Details

Related Information

Write Ack

Read Ack