Extensions.EventHandling.WaitForEvent
Jump to navigation
Jump to search
Classification
Name | WaitForEvent |
Short Description | Wait until an event is triggered and then continues processing |
Class | Action |
Extension | OTX EventHandling extension |
Group | EventHandling related actions |
Exceptions | - |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
EventHandling.WaitForEvent({EventSourceTerm[ ] source}, EventVariable event);
Description
The OTX WaitForEvent action will block the thread of execution until it receives an event from one of its event sources. As soon as an event becomes available in one of the sources' event queues, WaitForEvent will remove that event from the event source's queue and exit; the thread of execution continues to the next node.
If an event variable was specified, the event that caused WaitForEvent to exit is assigned to the variable.
Properties
Name | Data Type | Class | Default | Cardinality | Description |
Event | Event | Variable | - | [0..1] | This optional element represents an Event-type variable which will receive the event that terminates this wait. |
Source | EventSource | Term | - | [1..*] | This represents one or more event sources that the action will wait for. The wait will be terminated by the first source to fire an event. |
OTL Examples
/// Local Declarations
Integer Integer1;
EventHandling.EventSource EventSource1;
EventHandling.Event Event1;
/// Flow
EventSource1 = EventHandling.MonitorChangeEventSource(Integer1);
parallel
{
lane
{
EventHandling.WaitForEvent({EventSource1}, Event1);
}
lane
{
EventHandling.Sleep(500);
Integer1 = 13;
}
}