docs/source/TaskManager.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <title>The source code</title>
   6   <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   7   <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   8   <style type="text/css">
   9     .highlight { display: block; background-color: #ddd; }
  10   </style>
  11   <script type="text/javascript">
  12     function highlight() {
  13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
  14     }
  15   </script>
  16 </head>
  17 <body onload="prettyPrint(); highlight();">
  18   <pre class="prettyprint lang-js"><span id='Ext-util-TaskRunner-method-constructor'><span id='Ext-util-TaskRunner'>/**
  19 </span></span> * @class Ext.util.TaskRunner
  20  * Provides the ability to execute one or more arbitrary tasks in a multithreaded
  21  * manner.  Generally, you can use the singleton {@link Ext.TaskManager} instead, but
  22  * if needed, you can create separate instances of TaskRunner.  Any number of
  23  * separate tasks can be started at any time and will run independently of each
  24  * other. Example usage:
  25  * &lt;pre&gt;&lt;code&gt;
  26 // Start a simple clock task that updates a div once per second
  27 var updateClock = function(){
  28     Ext.fly('clock').update(new Date().format('g:i:s A'));
  29 }
  30 var task = {
  31     run: updateClock,
  32     interval: 1000 //1 second
  33 }
  34 var runner = new Ext.util.TaskRunner();
  35 runner.start(task);
  36
  37 // equivalent using TaskManager
  38 Ext.TaskManager.start({
  39     run: updateClock,
  40     interval: 1000
  41 });
  42
  43  * &lt;/code&gt;&lt;/pre&gt;
  44  * &lt;p&gt;See the {@link #start} method for details about how to configure a task object.&lt;/p&gt;
  45  * Also see {@link Ext.util.DelayedTask}.
  46  *
  47  * @constructor
  48  * @param {Number} [interval=10] The minimum precision in milliseconds supported by this TaskRunner instance
  49  */
  50 Ext.ns('Ext.util');
  51
  52 Ext.util.TaskRunner = function(interval) {
  53     interval = interval || 10;
  54     var tasks = [],
  55     removeQueue = [],
  56     id = 0,
  57     running = false,
  58
  59     // private
  60     stopThread = function() {
  61         running = false;
  62         clearInterval(id);
  63         id = 0;
  64     },
  65
  66     // private
  67     startThread = function() {
  68         if (!running) {
  69             running = true;
  70             id = setInterval(runTasks, interval);
  71         }
  72     },
  73
  74     // private
  75     removeTask = function(t) {
  76         removeQueue.push(t);
  77         if (t.onStop) {
  78             t.onStop.apply(t.scope || t);
  79         }
  80     },
  81
  82     // private
  83     runTasks = function() {
  84         var rqLen = removeQueue.length,
  85             now = new Date().getTime(),
  86             i;
  87
  88         if (rqLen &gt; 0) {
  89             for (i = 0; i &lt; rqLen; i++) {
  90                 Ext.Array.remove(tasks, removeQueue[i]);
  91             }
  92             removeQueue = [];
  93             if (tasks.length &lt; 1) {
  94                 stopThread();
  95                 return;
  96             }
  97         }
  98         i = 0;
  99         var t,
 100             itime,
 101             rt,
 102             len = tasks.length;
 103         for (; i &lt; len; ++i) {
 104             t = tasks[i];
 105             itime = now - t.taskRunTime;
 106             if (t.interval &lt;= itime) {
 107                 rt = t.run.apply(t.scope || t, t.args || [++t.taskRunCount]);
 108                 t.taskRunTime = now;
 109                 if (rt === false || t.taskRunCount === t.repeat) {
 110                     removeTask(t);
 111                     return;
 112                 }
 113             }
 114             if (t.duration &amp;&amp; t.duration &lt;= (now - t.taskStartTime)) {
 115                 removeTask(t);
 116             }
 117         }
 118     };
 119
 120 <span id='Ext-util-TaskRunner-method-start'>    /**
 121 </span>     * Starts a new task.
 122      * @method start
 123      * @param {Object} task &lt;p&gt;A config object that supports the following properties:&lt;ul&gt;
 124      * &lt;li&gt;&lt;code&gt;run&lt;/code&gt; : Function&lt;div class=&quot;sub-desc&quot;&gt;&lt;p&gt;The function to execute each time the task is invoked. The
 125      * function will be called at each interval and passed the &lt;code&gt;args&lt;/code&gt; argument if specified, and the
 126      * current invocation count if not.&lt;/p&gt;
 127      * &lt;p&gt;If a particular scope (&lt;code&gt;this&lt;/code&gt; reference) is required, be sure to specify it using the &lt;code&gt;scope&lt;/code&gt; argument.&lt;/p&gt;
 128      * &lt;p&gt;Return &lt;code&gt;false&lt;/code&gt; from this function to terminate the task.&lt;/p&gt;&lt;/div&gt;&lt;/li&gt;
 129      * &lt;li&gt;&lt;code&gt;interval&lt;/code&gt; : Number&lt;div class=&quot;sub-desc&quot;&gt;The frequency in milliseconds with which the task
 130      * should be invoked.&lt;/div&gt;&lt;/li&gt;
 131      * &lt;li&gt;&lt;code&gt;args&lt;/code&gt; : Array&lt;div class=&quot;sub-desc&quot;&gt;(optional) An array of arguments to be passed to the function
 132      * specified by &lt;code&gt;run&lt;/code&gt;. If not specified, the current invocation count is passed.&lt;/div&gt;&lt;/li&gt;
 133      * &lt;li&gt;&lt;code&gt;scope&lt;/code&gt; : Object&lt;div class=&quot;sub-desc&quot;&gt;(optional) The scope (&lt;tt&gt;this&lt;/tt&gt; reference) in which to execute the
 134      * &lt;code&gt;run&lt;/code&gt; function. Defaults to the task config object.&lt;/div&gt;&lt;/li&gt;
 135      * &lt;li&gt;&lt;code&gt;duration&lt;/code&gt; : Number&lt;div class=&quot;sub-desc&quot;&gt;(optional) The length of time in milliseconds to invoke
 136      * the task before stopping automatically (defaults to indefinite).&lt;/div&gt;&lt;/li&gt;
 137      * &lt;li&gt;&lt;code&gt;repeat&lt;/code&gt; : Number&lt;div class=&quot;sub-desc&quot;&gt;(optional) The number of times to invoke the task before
 138      * stopping automatically (defaults to indefinite).&lt;/div&gt;&lt;/li&gt;
 139      * &lt;/ul&gt;&lt;/p&gt;
 140      * &lt;p&gt;Before each invocation, Ext injects the property &lt;code&gt;taskRunCount&lt;/code&gt; into the task object so
 141      * that calculations based on the repeat count can be performed.&lt;/p&gt;
 142      * @return {Object} The task
 143      */
 144     this.start = function(task) {
 145         tasks.push(task);
 146         task.taskStartTime = new Date().getTime();
 147         task.taskRunTime = 0;
 148         task.taskRunCount = 0;
 149         startThread();
 150         return task;
 151     };
 152
 153 <span id='Ext-util-TaskRunner-method-stop'>    /**
 154 </span>     * Stops an existing running task.
 155      * @method stop
 156      * @param {Object} task The task to stop
 157      * @return {Object} The task
 158      */
 159     this.stop = function(task) {
 160         removeTask(task);
 161         return task;
 162     };
 163
 164 <span id='Ext-util-TaskRunner-method-stopAll'>    /**
 165 </span>     * Stops all tasks that are currently running.
 166      * @method stopAll
 167      */
 168     this.stopAll = function() {
 169         stopThread();
 170         for (var i = 0, len = tasks.length; i &lt; len; i++) {
 171             if (tasks[i].onStop) {
 172                 tasks[i].onStop();
 173             }
 174         }
 175         tasks = [];
 176         removeQueue = [];
 177     };
 178 };
 179
 180 <span id='Ext-TaskManager'>/**
 181 </span> * @class Ext.TaskManager
 182  * @extends Ext.util.TaskRunner
 183  * A static {@link Ext.util.TaskRunner} instance that can be used to start and stop arbitrary tasks.  See
 184  * {@link Ext.util.TaskRunner} for supported methods and task config properties.
 185  * &lt;pre&gt;&lt;code&gt;
 186 // Start a simple clock task that updates a div once per second
 187 var task = {
 188     run: function(){
 189         Ext.fly('clock').update(new Date().format('g:i:s A'));
 190     },
 191     interval: 1000 //1 second
 192 }
 193 Ext.TaskManager.start(task);
 194 &lt;/code&gt;&lt;/pre&gt;
 195  * &lt;p&gt;See the {@link #start} method for details about how to configure a task object.&lt;/p&gt;
 196  * @singleton
 197  */
 198 Ext.TaskManager = Ext.create('Ext.util.TaskRunner');</pre>
 199 </body>
 200 </html>