Process::getTimers Method
getTimers(jdoa: JadeDynamicObjectArray; count: Integer output);
The
The count parameter contains the total number of current timers for the process. If a process has more than 51 current timers, the count is the total number found but only the first 51 are returned.
The values are returned as properties of members inserted into the dynamic object array specified by the jdoa parameter. The properties returned in the JADE dynamic objects are listed in the following table.
Property | Type | Description |
---|---|---|
name | String | CurrentTimers. |
type | Integer | 117. |
receiver | Object | Oid of the timer event method receiver. |
eventTag | Integer | Event tag of the timer. |
delay | Integer | Specified delay period of the timer, in milliseconds. |
option | Integer | Option used when the timer was started; that is, Timer_Continuous (0) or Timer_One_Shot (1). |
fired | Boolean | true if the timer has been fired and the timer event method is still in progress or has not yet been invoked. |
inCallBack | Boolean | true if the timer event method is in progress. |
exceptionState | Boolean | true if the target process is in exception state. |
remainingTime | Integer | Number of milliseconds left until the timer is next fired. |
Application | Object | Application of the process that was in effect when the timer was started. |
interfaceNumber | Integer | Number of the JadeInterface specified when the timer was started (with the |
serverExecution | Boolean | true if the timer was started in a |
Members are created and added to the object array when the method is first called. When used in subsequent class, the array is purged before new members are added. The calling process is responsible for purging and deleting the JADE dynamic object array when it is no longer required.
The JADE Monitor uses this method to display a table in the Timers view in the Process Information activity group.
If a timer was started in a
Timer event methods are not called while the process is in exception state but are deferred until the process is no longer in exception state. The exceptionState attribute returned in the dynamic object array indicates when this is the case.