Timeout
- Updated2023-02-17
- 3 minute(s) read
Timeout
Immediately flushes data from the writer and disables the stream. In this mode, you specify an amount of time to wait for the flush to complete.
Flushing the writer prevents the writer from accepting new data and sends all existing data in the writer to the stream.
If you do not want to flush the writer before disabling the stream, use Disable Peer to Peer Stream.
Inputs/Outputs
session in
A reference to the stream.
error in
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Default value: No error
flush timeout
The amount of time, in milliseconds, to wait for the function to complete the flush of the writer.
If the flush does not complete within the time you specify in flush timeout, the function disables the stream and any data remaining in the writer is lost.
Specifying an Indefinite Timeout
To wait indefinitely, set flush timeout to -1. Alternately, you can use Flush and Disable Peer to Peer Stream (No Timeout) to wait indefinitely.
session out
A reference to the stream.
error out
Error information.
The node produces this output according to standard error behavior.
Specifying a Timeout
This function waits until the flush is complete or the time you specify in flush timeout is exceeded. If the function does not time out, the reader receives all data from the writer before the stream transitions to the Disabled state. If the function does time out, you lose any data remaining on the writer side of the stream. If this function times out, verify that the value for flush timeout is appropriate for the number of elements you expect to flush and that the reader continues to read data until the stream is empty.