TaskLoop
Sub-class specialization of EventHandler base class.
TaskLoop allows to schedule a task function being called (optionnaly repeatedly) on the main loop, scheduled asynchroneously, avoiding recursive calls in the same tick.
The task itself is implemented in doTick. It can be requested and called for single execution
using the tick method.
It will be assured that the task execution method (tick) only gets called once per main loop "tick",
no matter how often it gets requested for execution. Execution in further ticks will be scheduled accordingly.
If further execution requests have already been scheduled on the next tick, it can be checked with hasNextTick,
and cancelled with clearNextTick.
The task can be scheduled as an interval repeatedly with a period as parameter (see setInterval, clearInterval).
Sub-classes need to implement the doTick method which will effectively have the task execution routine.
Further explanations:
The baseclass has a tick method that will schedule the doTick call. It may be called synchroneously
only for a stack-depth of one. On re-entrant calls, sub-sequent calls are scheduled for next main loop ticks.
When the task execution (tick method) is called in re-entrant way this is detected and
we are limiting the task execution per call stack to exactly one, but scheduling/post-poning further
task processing on the next main loop iteration (also known as "next tick" in the Node/JS runtime lingo).
Constructor Summary
| Public Constructor | ||
| public |
|
|
Member Summary
| Private Members | ||
| private |
_boundTick: * |
|
| private |
|
|
| private |
|
|
| private |
_tickTimer: * |
|
Method Summary
| Public Methods | ||
| public |
|
|
| public |
|
|
| public |
destroy() |
|
| public |
doTick() For subclass to implement task logic |
|
| public |
|
|
| public |
|
|
| public |
|
|
| public |
|
|
| public |
setInterval(millis: number): boolean |
|
| public |
tick() Will call the subclass doTick implementation in this main loop tick or in the next one (via setTimeout(,0)) in case it has already been called in this tick (in case this is a re-entrant call). |
|
| public |
|
|
Public Constructors
public constructor() source
Private Members
private _boundTick: * source
private _tickInterval: * source
private _tickTimer: * source
Public Methods
public destroy() source
public onHandlerDestroyed() source
public onHandlerDestroying() source
public setInterval(millis: number): boolean source
Params:
| Name | Type | Attribute | Description |
| millis | number | Interval time (ms) |
public tick() source
Will call the subclass doTick implementation in this main loop tick or in the next one (via setTimeout(,0)) in case it has already been called in this tick (in case this is a re-entrant call).