7.22 Pulse Object
| Used on |
|
| Description | The pulse event is an event that is triggered by time rather than events in a space.
The most common use of the pulse is to specify a recurring event, by setting the 'period' field,
possibly also setting an initial delay.
Another usage is likely to be an event to start the main thread of the application, by specifying an initialDelay without a period.
There is actually a special name for this - a clientStart, which is equivalent to a pulse with no period (only fires once) and no delay.
If the 'period' is specified, then the pulse is constantly recurring after the specified period time;
if not, it is a one-shot.
|
Inherited
properties |
| template |
(base property)
| |
| text |
(base property)
| |
| jwpattern |
(base property)
| |
|
7.22.1 Property 'description'
|
7.22.2 Property 'initialDelay'
|
| Description | If this value is set, it must be >= 0 and indicates that the push event is to start after this amount of time in milliseconds.
The default is 0 and indicates that this pulse will be fired without delay.
|
| Type | long |
| Default | 0 |
7.22.3 Property 'name'
|
| Description | Gives the name of the pulse event. This will be used to identify the method in the PU's actions class.
The name is required and must be unique across all actions (i.e. including pulses and event actions) within a given PU.
|
| Type | String |
| Required | true |
7.22.4 Property 'period'
|
| Description | If this value is specified, it should be > 0 and indicates that the event is to be repeated, this amount of milliseconds apart; this is a periodic pulse.
The default is -1. For any period <= 0, the pulse does not reoccur.
It is therefore a one-shot (kickstart) that can be used to start a thread once for the PU.
|
| Type | long |
| Default | -1 |
|
