Class core.ScheduledTask
A scheduled task allows multiple requests for the same function to
be aggregated into a single call at a future time. This is useful for
batching up draw requests or other lower-priority or high-volume calls
Defined in: ScheduledTask.js.
Constructor Attributes | Constructor Name and Description |
---|---|
core.ScheduledTask(fn, scheduleTask, cancelTask)
|
Field Attributes | Field Name and Description |
---|---|
Cancel any current pending requests
|
Method Attributes | Method Name and Description |
---|---|
destroy(callback)
Cancel any pending requests
|
|
Execute any pending requests, but do not start any new ones.
|
|
trigger()
Schedule this task to execute.
|
|
Immediately trigger this task and clear any pending requests.
|
Class Detail
core.ScheduledTask(fn, scheduleTask, cancelTask)
- Parameters:
- {!Function} fn
- The function to execute for this task
- {!function(!function():undefined):!number} scheduleTask
- Schedule the task to execute
- {!function(!number):undefined} cancelTask
- Cancel a scheduled task
Field Detail
cancel
Cancel any current pending requests
Method Detail
destroy(callback)
Cancel any pending requests
- Parameters:
- {!function(!Error=)} callback
processRequests()
Execute any pending requests, but do not start any new ones.
If there are no pending requests, this call will do nothing.
trigger()
Schedule this task to execute. If one has already been requested,
this call will have no impact
triggerImmediate()
Immediately trigger this task and clear any pending requests.