Timeout#
The Timeout task allows users to configure a task that triggers after a specified time interval.
Inputs#
| Name | Data Type | Description |
|---|---|---|
| Interval | Integer | Interval from activation time until emit |
| Enable/Disable | Boolean | In Data Flow, true starts the timeout and false cancels it |
Outputs#
| Name | Data Type | Description |
|---|---|---|
| Timestamp | DateTime | Current time upon execution |
| Success | Boolean | In Control Flow, emits true when the task ends. Not emitted in Data Flow |
| Error | Error | Error that occurred during the processing of this task |
Settings#
| Name | Data Type | Default | Description |
|---|---|---|---|
| Interval | Integer | 10000 | Number of milliseconds to Timeout |
Behavior#
In Data Flow, a true on the Enable/Disable input starts the timeout and a false cancels it. A true while the timeout is running is ignored and does not restart it. When the interval passes before a false arrives, the task emits Timestamp and the error Timeout of '<interval>' ms occurred on Error. A timeout canceled in time emits nothing.
In Control Flow, the task runs its handler branch with the interval as a time limit. When the limit passes, the handler branch is stopped, its remaining tasks do not run, and the timeout branch runs with no time limit. In both cases, the task then emits Timestamp and Success, and the flow continues with the next task. The task logs Successfully executed the tasks within the timeout protected area in both cases, and the controller logs the stopped handler branch at error level.
