Description
Type
Flow control.
Behaviour
Wait until an event occurs. The task can be unlocked by means of the command “OPH_INPUT”.
Parameters
- type : waiting type. Use: “clock” for fixed time; “input” to ask to input data and set a new “value” for “key”; “file” to check the existence of a file.
- timeout : according to the value of parameter “timeout_type”, it is the duration (in seconds) or the end instant of the waiting interval. In the second case use one of the following date formats:
- yyyy
- yyyy-mm
- yyyy-mm-dd
- yyyy-mm-dd hh
- yyyy-mm-dd hh:mm
- yyyy-mm-dd hh:mm:ss The operator will convert the date into the number of seconds elapsed since the Epoch, 1970-01-01 00:00:00 +0000 (UTC). If the value is negative then waiting time is infinity (default).
- timeout_type : meaning the value of “timeout”. Use: “duration” to set the duration of waiting interval; “deadline” to set the end time instant of waiting interval.
- key : name of the parameter. It should comply with IEEE Std 1003.1-2001 conventions, unless brackets {} are adopted to refer it. More keys are allowed.
- value : value of the parameter. It can be accessed with @key or @{key}. More values are allowed, one for each key.
- filename : name of the file to be checked (only for type “file”); base folder to refer files is BASE_SRC_PATH (see oph_configuration for additional information).
- message : this user-defined message is appended to response in order to notify the waiting reason.
- run : set to yes (default) to wait effectively
Examples
Wait for 200 seconds:
[OPH_TERM] >> oph_wait timeout=200;
