The source code

/** + + + + The source code + + + + +

/*!
+ * Ext JS Library 3.2.2
+ * Copyright(c) 2006-2010 Ext JS, Inc.
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+/**
  * @class Ext.util.TaskRunner
  * Provides the ability to execute one or more arbitrary tasks in a multithreaded
  * manner.  Generally, you can use the singleton {@link Ext.TaskMgr} instead, but
@@ -32,6 +38,7 @@ Ext.TaskMgr.start({
 });
 
  *

+ *

See the {@link #start} method for details about how to configure a task object.

* Also see {@link Ext.util.DelayedTask}. * * @constructor @@ -103,21 +110,25 @@ Ext.util.TaskRunner = function(interval){

/** * Starts a new task. * @method start - * @param {Object} task A config object that supports the following properties:

run : Function
The function to execute each time the task is run. The - * function will be called at each interval and passed the args argument if specified. If a - * particular scope is required, be sure to specify it using the scope argument.

A config object that supports the following properties:

run : Function
The function to execute each time the task is invoked. The + * function will be called at each interval and passed the args argument if specified, and the + * current invocation count if not.
+ *
If a particular scope (this reference) is required, be sure to specify it using the scope argument.
+ *
Return false from this function to terminate the task.
interval : Number
The frequency in milliseconds with which the task - * should be executed.
args : Array
(optional) An array of arguments to be passed to the function - * specified by run.

run

scope : Object
(optional) The scope (this reference) in which to execute the * run function. Defaults to the task config object.
duration : Number
(optional) The length of time in milliseconds to execute + *
duration : Number
(optional) The length of time in milliseconds to invoke * the task before stopping automatically (defaults to indefinite).
repeat : Number
(optional) The number of times to execute the task before + *
repeat : Number
(optional) The number of times to invoke the task before * stopping automatically (defaults to indefinite).

+ *

Before each invocation, Ext injects the property taskRunCount into the task object so + * that calculations based on the repeat count can be performed.

* @return {Object} The task */ this.start = function(task){ @@ -171,8 +182,9 @@ var task = { } Ext.TaskMgr.start(task);