|
0
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
|
2 |
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
|
3 |
<head> |
|
|
4 |
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
|
5 |
<title>API: async-queue async-queue.js (YUI Library)</title> |
|
|
6 |
|
|
|
7 |
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
|
8 |
<link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
|
9 |
|
|
|
10 |
<script type="text/javascript" src="assets/api-js"></script> |
|
|
11 |
<script type="text/javascript" src="assets/ac-js"></script> |
|
|
12 |
</head> |
|
|
13 |
|
|
|
14 |
<body id="yahoo-com"> |
|
|
15 |
|
|
|
16 |
<div id="doc3" class="yui-t2"> |
|
|
17 |
<div id="hd"> |
|
|
18 |
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
|
19 |
<h3>async-queue <span class="subtitle">3.0.0</span></h3> |
|
|
20 |
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
|
21 |
> <a href="./module_async-queue.html" title="async-queue">async-queue</a> |
|
|
22 |
|
|
|
23 |
> async-queue.js (source view) |
|
|
24 |
<form onsubmit="return false"> |
|
|
25 |
<div id="propertysearch"> |
|
|
26 |
Search: <input autocomplete="off" id="searchinput" /> |
|
|
27 |
<div id="searchresults"> |
|
|
28 |
|
|
|
29 |
</div> |
|
|
30 |
</div> |
|
|
31 |
</form> |
|
|
32 |
</div> |
|
|
33 |
|
|
|
34 |
<div id="bd"> |
|
|
35 |
<div id="yui-main"> |
|
|
36 |
<div class="yui-b"> |
|
|
37 |
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
|
38 |
<fieldset> |
|
|
39 |
<legend>Filters</legend> |
|
|
40 |
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
|
41 |
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
|
42 |
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
|
43 |
</fieldset> |
|
|
44 |
</form> |
|
|
45 |
|
|
|
46 |
<div id="srcout"> |
|
|
47 |
<style> |
|
|
48 |
#doc3 .classopts { display:none; } |
|
|
49 |
</style> |
|
|
50 |
<div class="highlight" ><pre><span class="c">/**</span> |
|
|
51 |
<span class="c"> * <p>AsyncQueue allows you create a chain of function callbacks executed</span> |
|
|
52 |
<span class="c"> * via setTimeout (or synchronously) that are guaranteed to run in order.</span> |
|
|
53 |
<span class="c"> * Items in the queue can be promoted or removed. Start or resume the</span> |
|
|
54 |
<span class="c"> * execution chain with run(). pause() to temporarily delay execution, or</span> |
|
|
55 |
<span class="c"> * stop() to halt and clear the queue.</p></span> |
|
|
56 |
<span class="c"> *</span> |
|
|
57 |
<span class="c"> * @module async-queue</span> |
|
|
58 |
<span class="c"> */</span> |
|
|
59 |
|
|
|
60 |
<span class="c">/**</span> |
|
|
61 |
<span class="c"> * <p>A specialized queue class that supports scheduling callbacks to execute</span> |
|
|
62 |
<span class="c"> * sequentially, iteratively, even asynchronously.</p></span> |
|
|
63 |
<span class="c"> *</span> |
|
|
64 |
<span class="c"> * <p>Callbacks can be function refs or objects with the following keys. Only</span> |
|
|
65 |
<span class="c"> * the <code>fn</code> key is required.</p></span> |
|
|
66 |
<span class="c"> *</span> |
|
|
67 |
<span class="c"> * <ul></span> |
|
|
68 |
<span class="c"> * <li><code>fn</code> -- The callback function</li></span> |
|
|
69 |
<span class="c"> * <li><code>context</code> -- The execution context for the callbackFn.</li></span> |
|
|
70 |
<span class="c"> * <li><code>args</code> -- Arguments to pass to callbackFn.</li></span> |
|
|
71 |
<span class="c"> * <li><code>timeout</code> -- Millisecond delay before executing callbackFn.</span> |
|
|
72 |
<span class="c"> * (Applies to each iterative execution of callback)</li></span> |
|
|
73 |
<span class="c"> * <li><code>iterations</code> -- Number of times to repeat the callback.</span> |
|
|
74 |
<span class="c"> * <li><code>until</code> -- Repeat the callback until this function returns</span> |
|
|
75 |
<span class="c"> * true. This setting trumps iterations.</li></span> |
|
|
76 |
<span class="c"> * <li><code>autoContinue</code> -- Set to false to prevent the AsyncQueue from</span> |
|
|
77 |
<span class="c"> * executing the next callback in the Queue after</span> |
|
|
78 |
<span class="c"> * the callback completes.</li></span> |
|
|
79 |
<span class="c"> * <li><code>id</code> -- Name that can be used to get, promote, get the</span> |
|
|
80 |
<span class="c"> * indexOf, or delete this callback.</li></span> |
|
|
81 |
<span class="c"> * </ul></span> |
|
|
82 |
<span class="c"> *</span> |
|
|
83 |
<span class="c"> * @class AsyncQueue</span> |
|
|
84 |
<span class="c"> * @extends EventTarget</span> |
|
|
85 |
<span class="c"> * @constructor</span> |
|
|
86 |
<span class="c"> * @param callback* {Function|Object} 0..n callbacks to seed the queue</span> |
|
|
87 |
<span class="c"> */</span> |
|
|
88 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">AsyncQueue</span> <span class="o">=</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
|
89 |
<span class="k">this</span><span class="o">.</span><span class="nx">_init</span><span class="o">();</span> |
|
|
90 |
<span class="k">this</span><span class="o">.</span><span class="nx">add</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="k">this</span><span class="o">,</span> <span class="nx">arguments</span><span class="o">);</span> |
|
|
91 |
<span class="o">};</span> |
|
|
92 |
|
|
|
93 |
<span class="k">var</span> <span class="nx">Queue</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">AsyncQueue</span><span class="o">,</span> |
|
|
94 |
<span class="nx">EXECUTE</span> <span class="o">=</span> <span class="s1">'execute'</span><span class="o">,</span> |
|
|
95 |
<span class="nx">SHIFT</span> <span class="o">=</span> <span class="s1">'shift'</span><span class="o">,</span> |
|
|
96 |
<span class="nx">PROMOTE</span> <span class="o">=</span> <span class="s1">'promote'</span><span class="o">,</span> |
|
|
97 |
<span class="nx">REMOVE</span> <span class="o">=</span> <span class="s1">'remove'</span><span class="o">,</span> |
|
|
98 |
|
|
|
99 |
<span class="nx">isObject</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Lang</span><span class="o">.</span><span class="nx">isObject</span><span class="o">,</span> |
|
|
100 |
<span class="nx">isFunction</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Lang</span><span class="o">.</span><span class="nx">isFunction</span><span class="o">;</span> |
|
|
101 |
|
|
|
102 |
<span class="c">/**</span> |
|
|
103 |
<span class="c"> * <p>Static default values used to populate callback configuration properties.</span> |
|
|
104 |
<span class="c"> * Preconfigured defaults include:</p></span> |
|
|
105 |
<span class="c"> *</span> |
|
|
106 |
<span class="c"> * <ul></span> |
|
|
107 |
<span class="c"> * <li><code>autoContinue</code>: <code>true</code></li></span> |
|
|
108 |
<span class="c"> * <li><code>iterations</code>: 1</li></span> |
|
|
109 |
<span class="c"> * <li><code>timeout</code>: 10 (10ms between callbacks)</li></span> |
|
|
110 |
<span class="c"> * <li><code>until</code>: (function to run until iterations &lt;= 0)</li></span> |
|
|
111 |
<span class="c"> * </ul></span> |
|
|
112 |
<span class="c"> *</span> |
|
|
113 |
<span class="c"> * @property AsyncQueue.defaults</span> |
|
|
114 |
<span class="c"> * @type {Object}</span> |
|
|
115 |
<span class="c"> * @static</span> |
|
|
116 |
<span class="c"> */</span> |
|
|
117 |
<span class="nx">Queue</span><span class="o">.</span><span class="nx">defaults</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">({</span> |
|
|
118 |
<span class="nx">autoContinue</span> <span class="o">:</span> <span class="kc">true</span><span class="o">,</span> |
|
|
119 |
<span class="nx">iterations</span> <span class="o">:</span> <span class="m">1</span><span class="o">,</span> |
|
|
120 |
<span class="nx">timeout</span> <span class="o">:</span> <span class="m">10</span><span class="o">,</span> |
|
|
121 |
<span class="nx">until</span> <span class="o">:</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
122 |
<span class="k">this</span><span class="o">.</span><span class="nx">iterations</span> <span class="o">|=</span> <span class="m">0</span><span class="o">;</span> |
|
|
123 |
<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">iterations</span> <span class="o"><=</span> <span class="m">0</span><span class="o">;</span> |
|
|
124 |
<span class="o">}</span> |
|
|
125 |
<span class="o">},</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">config</span><span class="o">.</span><span class="nx">queueDefaults</span> <span class="o">||</span> <span class="o">{});</span> |
|
|
126 |
|
|
|
127 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">extend</span><span class="o">(</span><span class="nx">Queue</span><span class="o">,</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">EventTarget</span><span class="o">,</span> <span class="o">{</span> |
|
|
128 |
<span class="c">/**</span> |
|
|
129 |
<span class="c"> * Used to indicate the queue is currently executing a callback.</span> |
|
|
130 |
<span class="c"> *</span> |
|
|
131 |
<span class="c"> * @property _running</span> |
|
|
132 |
<span class="c"> * @type {Boolean|Object} true for synchronous callback execution, the</span> |
|
|
133 |
<span class="c"> * return handle from Y.later for async callbacks.</span> |
|
|
134 |
<span class="c"> * Otherwise false.</span> |
|
|
135 |
<span class="c"> * @protected</span> |
|
|
136 |
<span class="c"> */</span> |
|
|
137 |
<span class="nx">_running</span> <span class="o">:</span> <span class="kc">false</span><span class="o">,</span> |
|
|
138 |
|
|
|
139 |
<span class="c">/**</span> |
|
|
140 |
<span class="c"> * Initializes the AsyncQueue instance properties and events.</span> |
|
|
141 |
<span class="c"> *</span> |
|
|
142 |
<span class="c"> * @method _init</span> |
|
|
143 |
<span class="c"> * @protected</span> |
|
|
144 |
<span class="c"> */</span> |
|
|
145 |
<span class="nx">_init</span> <span class="o">:</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
146 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">EventTarget</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="k">this</span><span class="o">,</span> <span class="o">{</span> <span class="nx">emitFacade</span><span class="o">:</span> <span class="kc">true</span> <span class="o">});</span> |
|
|
147 |
|
|
|
148 |
<span class="k">this</span><span class="o">.</span><span class="nx">_q</span> <span class="o">=</span> <span class="o">[];</span> |
|
|
149 |
|
|
|
150 |
<span class="c">/** </span> |
|
|
151 |
<span class="c"> * Callback defaults for this instance. Static defaults that are not</span> |
|
|
152 |
<span class="c"> * overridden are also included.</span> |
|
|
153 |
<span class="c"> *</span> |
|
|
154 |
<span class="c"> * @property defaults</span> |
|
|
155 |
<span class="c"> * @type {Object}</span> |
|
|
156 |
<span class="c"> */</span> |
|
|
157 |
<span class="k">this</span><span class="o">.</span><span class="nx">defaults</span> <span class="o">=</span> <span class="o">{};</span> |
|
|
158 |
|
|
|
159 |
<span class="k">this</span><span class="o">.</span><span class="nx">_initEvents</span><span class="o">();</span> |
|
|
160 |
<span class="o">},</span> |
|
|
161 |
|
|
|
162 |
<span class="c">/**</span> |
|
|
163 |
<span class="c"> * Initializes the instance events.</span> |
|
|
164 |
<span class="c"> *</span> |
|
|
165 |
<span class="c"> * @method _initEvents</span> |
|
|
166 |
<span class="c"> * @protected</span> |
|
|
167 |
<span class="c"> */</span> |
|
|
168 |
<span class="nx">_initEvents</span> <span class="o">:</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
169 |
<span class="c">/*</span> |
|
|
170 |
<span class="c"> this.publish({</span> |
|
|
171 |
<span class="c"> 'execute' : { defaultFn : this._defExecFn },</span> |
|
|
172 |
<span class="c"> 'shift' : { defaultFn : this._defShiftFn },</span> |
|
|
173 |
<span class="c"> 'add' : { defaultFn : this._defAddFn },</span> |
|
|
174 |
<span class="c"> 'promote' : { defaultFn : this._defPromoteFn },</span> |
|
|
175 |
<span class="c"> 'remove' : { defaultFn : this._defRemoveFn }</span> |
|
|
176 |
<span class="c"> });</span> |
|
|
177 |
<span class="c"> */</span> |
|
|
178 |
<span class="k">this</span><span class="o">.</span><span class="nx">publish</span><span class="o">(</span><span class="s1">'execute'</span> <span class="o">,</span> <span class="o">{</span> <span class="nx">defaultFn</span> <span class="o">:</span> <span class="k">this</span><span class="o">.</span><span class="nx">_defExecFn</span><span class="o">,</span> <span class="nx">emitFacade</span><span class="o">:</span> <span class="kc">true</span> <span class="o">});</span> |
|
|
179 |
<span class="k">this</span><span class="o">.</span><span class="nx">publish</span><span class="o">(</span><span class="s1">'shift'</span> <span class="o">,</span> <span class="o">{</span> <span class="nx">defaultFn</span> <span class="o">:</span> <span class="k">this</span><span class="o">.</span><span class="nx">_defShiftFn</span><span class="o">,</span> <span class="nx">emitFacade</span><span class="o">:</span> <span class="kc">true</span> <span class="o">});</span> |
|
|
180 |
<span class="k">this</span><span class="o">.</span><span class="nx">publish</span><span class="o">(</span><span class="s1">'add'</span> <span class="o">,</span> <span class="o">{</span> <span class="nx">defaultFn</span> <span class="o">:</span> <span class="k">this</span><span class="o">.</span><span class="nx">_defAddFn</span><span class="o">,</span> <span class="nx">emitFacade</span><span class="o">:</span> <span class="kc">true</span> <span class="o">});</span> |
|
|
181 |
<span class="k">this</span><span class="o">.</span><span class="nx">publish</span><span class="o">(</span><span class="s1">'promote'</span> <span class="o">,</span> <span class="o">{</span> <span class="nx">defaultFn</span> <span class="o">:</span> <span class="k">this</span><span class="o">.</span><span class="nx">_defPromoteFn</span><span class="o">,</span> <span class="nx">emitFacade</span><span class="o">:</span> <span class="kc">true</span> <span class="o">});</span> |
|
|
182 |
<span class="k">this</span><span class="o">.</span><span class="nx">publish</span><span class="o">(</span><span class="s1">'remove'</span> <span class="o">,</span> <span class="o">{</span> <span class="nx">defaultFn</span> <span class="o">:</span> <span class="k">this</span><span class="o">.</span><span class="nx">_defRemoveFn</span><span class="o">,</span> <span class="nx">emitFacade</span><span class="o">:</span> <span class="kc">true</span> <span class="o">});</span> |
|
|
183 |
<span class="o">},</span> |
|
|
184 |
|
|
|
185 |
<span class="c">/**</span> |
|
|
186 |
<span class="c"> * Returns the next callback needing execution. If a callback is</span> |
|
|
187 |
<span class="c"> * configured to repeat via iterations or until, it will be returned until</span> |
|
|
188 |
<span class="c"> * the completion criteria is met.</span> |
|
|
189 |
<span class="c"> *</span> |
|
|
190 |
<span class="c"> * When the queue is empty, null is returned.</span> |
|
|
191 |
<span class="c"> *</span> |
|
|
192 |
<span class="c"> * @method next</span> |
|
|
193 |
<span class="c"> * @return {Function} the callback to execute</span> |
|
|
194 |
<span class="c"> */</span> |
|
|
195 |
<span class="nx">next</span> <span class="o">:</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
196 |
<span class="k">var</span> <span class="nx">callback</span><span class="o">;</span> |
|
|
197 |
|
|
|
198 |
<span class="k">while</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_q</span><span class="o">.</span><span class="nx">length</span><span class="o">)</span> <span class="o">{</span> |
|
|
199 |
<span class="nx">callback</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_q</span><span class="o">[</span><span class="m">0</span><span class="o">]</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_prepare</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_q</span><span class="o">[</span><span class="m">0</span><span class="o">]);</span> |
|
|
200 |
<span class="k">if</span> <span class="o">(</span><span class="nx">callback</span> <span class="o">&&</span> <span class="nx">callback</span><span class="o">.</span><span class="nx">until</span><span class="o">())</span> <span class="o">{</span> |
|
|
201 |
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">SHIFT</span><span class="o">,</span> <span class="o">{</span> <span class="nx">callback</span><span class="o">:</span> <span class="nx">callback</span> <span class="o">});</span> |
|
|
202 |
<span class="nx">callback</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span> |
|
|
203 |
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
|
204 |
<span class="k">break</span><span class="o">;</span> |
|
|
205 |
<span class="o">}</span> |
|
|
206 |
<span class="o">}</span> |
|
|
207 |
|
|
|
208 |
<span class="k">return</span> <span class="nx">callback</span> <span class="o">||</span> <span class="kc">null</span><span class="o">;</span> |
|
|
209 |
<span class="o">},</span> |
|
|
210 |
|
|
|
211 |
<span class="c">/**</span> |
|
|
212 |
<span class="c"> * Default functionality for the &quot;shift&quot; event. Shifts the</span> |
|
|
213 |
<span class="c"> * callback stored in the event object's <em>callback</em> property from</span> |
|
|
214 |
<span class="c"> * the queue if it is the first item.</span> |
|
|
215 |
<span class="c"> *</span> |
|
|
216 |
<span class="c"> * @method _defShiftFn</span> |
|
|
217 |
<span class="c"> * @param e {Event} The event object</span> |
|
|
218 |
<span class="c"> * @protected</span> |
|
|
219 |
<span class="c"> */</span> |
|
|
220 |
<span class="nx">_defShiftFn</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span> |
|
|
221 |
<span class="k">if</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">indexOf</span><span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">callback</span><span class="o">)</span> <span class="o">===</span> <span class="m">0</span><span class="o">)</span> <span class="o">{</span> |
|
|
222 |
<span class="k">this</span><span class="o">.</span><span class="nx">_q</span><span class="o">.</span><span class="nx">shift</span><span class="o">();</span> |
|
|
223 |
<span class="o">}</span> |
|
|
224 |
<span class="o">},</span> |
|
|
225 |
|
|
|
226 |
<span class="c">/**</span> |
|
|
227 |
<span class="c"> * Creates a wrapper function to execute the callback using the aggregated </span> |
|
|
228 |
<span class="c"> * configuration generated by combining the static AsyncQueue.defaults, the</span> |
|
|
229 |
<span class="c"> * instance defaults, and the specified callback settings.</span> |
|
|
230 |
<span class="c"> *</span> |
|
|
231 |
<span class="c"> * The wrapper function is decorated with the callback configuration as</span> |
|
|
232 |
<span class="c"> * properties for runtime modification.</span> |
|
|
233 |
<span class="c"> *</span> |
|
|
234 |
<span class="c"> * @method _prepare</span> |
|
|
235 |
<span class="c"> * @param callback {Object|Function} the raw callback</span> |
|
|
236 |
<span class="c"> * @return {Function} a decorated function wrapper to execute the callback</span> |
|
|
237 |
<span class="c"> * @protected</span> |
|
|
238 |
<span class="c"> */</span> |
|
|
239 |
<span class="nx">_prepare</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">callback</span><span class="o">)</span> <span class="o">{</span> |
|
|
240 |
<span class="k">if</span> <span class="o">(</span><span class="nx">isFunction</span><span class="o">(</span><span class="nx">callback</span><span class="o">)</span> <span class="o">&&</span> <span class="nx">callback</span><span class="o">.</span><span class="nx">_prepared</span><span class="o">)</span> <span class="o">{</span> |
|
|
241 |
<span class="k">return</span> <span class="nx">callback</span><span class="o">;</span> |
|
|
242 |
<span class="o">}</span> |
|
|
243 |
|
|
|
244 |
<span class="k">var</span> <span class="nx">config</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">merge</span><span class="o">(</span> |
|
|
245 |
<span class="nx">Queue</span><span class="o">.</span><span class="nx">defaults</span><span class="o">,</span> |
|
|
246 |
<span class="o">{</span> <span class="nx">context</span> <span class="o">:</span> <span class="k">this</span><span class="o">,</span> <span class="nx">args</span><span class="o">:</span> <span class="o">[],</span> <span class="nx">_prepared</span><span class="o">:</span> <span class="kc">true</span> <span class="o">},</span> |
|
|
247 |
<span class="k">this</span><span class="o">.</span><span class="nx">defaults</span><span class="o">,</span> |
|
|
248 |
<span class="o">(</span><span class="nx">isFunction</span><span class="o">(</span><span class="nx">callback</span><span class="o">)</span> <span class="o">?</span> <span class="o">{</span> <span class="nx">fn</span><span class="o">:</span> <span class="nx">callback</span> <span class="o">}</span> <span class="o">:</span> <span class="nx">callback</span><span class="o">)),</span> |
|
|
249 |
|
|
|
250 |
<span class="nx">wrapper</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">bind</span><span class="o">(</span><span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
251 |
<span class="k">if</span> <span class="o">(!</span><span class="nx">wrapper</span><span class="o">.</span><span class="nx">_running</span><span class="o">)</span> <span class="o">{</span> |
|
|
252 |
<span class="nx">wrapper</span><span class="o">.</span><span class="nx">iterations</span><span class="o">--;</span> |
|
|
253 |
<span class="o">}</span> |
|
|
254 |
<span class="k">if</span> <span class="o">(</span><span class="nx">isFunction</span><span class="o">(</span><span class="nx">wrapper</span><span class="o">.</span><span class="nx">fn</span><span class="o">))</span> <span class="o">{</span> |
|
|
255 |
<span class="nx">wrapper</span><span class="o">.</span><span class="nx">fn</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="nx">wrapper</span><span class="o">.</span><span class="nx">context</span> <span class="o">||</span> <span class="nx">Y</span><span class="o">,</span> |
|
|
256 |
<span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">wrapper</span><span class="o">.</span><span class="nx">args</span><span class="o">));</span> |
|
|
257 |
<span class="o">}</span> |
|
|
258 |
<span class="o">},</span> <span class="k">this</span><span class="o">);</span> |
|
|
259 |
|
|
|
260 |
<span class="k">return</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">(</span><span class="nx">wrapper</span><span class="o">,</span> <span class="nx">config</span><span class="o">);</span> |
|
|
261 |
<span class="o">},</span> |
|
|
262 |
|
|
|
263 |
<span class="c">/**</span> |
|
|
264 |
<span class="c"> * Sets the queue in motion. All queued callbacks will be executed in</span> |
|
|
265 |
<span class="c"> * order unless pause() or stop() is called or if one of the callbacks is</span> |
|
|
266 |
<span class="c"> * configured with autoContinue: false.</span> |
|
|
267 |
<span class="c"> *</span> |
|
|
268 |
<span class="c"> * @method run</span> |
|
|
269 |
<span class="c"> * @return {AsyncQueue} the AsyncQueue instance</span> |
|
|
270 |
<span class="c"> * @chainable</span> |
|
|
271 |
<span class="c"> */</span> |
|
|
272 |
<span class="nx">run</span> <span class="o">:</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
273 |
<span class="k">var</span> <span class="nx">callback</span><span class="o">,</span> |
|
|
274 |
<span class="nx">cont</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> |
|
|
275 |
|
|
|
276 |
<span class="k">for</span> <span class="o">(</span><span class="nx">callback</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">next</span><span class="o">();</span> |
|
|
277 |
<span class="nx">cont</span> <span class="o">&&</span> <span class="nx">callback</span> <span class="o">&&</span> <span class="o">!</span><span class="k">this</span><span class="o">.</span><span class="nx">isRunning</span><span class="o">();</span> |
|
|
278 |
<span class="nx">callback</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">next</span><span class="o">())</span> |
|
|
279 |
<span class="o">{</span> |
|
|
280 |
<span class="nx">cont</span> <span class="o">=</span> <span class="o">(</span><span class="nx">callback</span><span class="o">.</span><span class="nx">timeout</span> <span class="o"><</span> <span class="m">0</span><span class="o">)</span> <span class="o">?</span> |
|
|
281 |
<span class="k">this</span><span class="o">.</span><span class="nx">_execute</span><span class="o">(</span><span class="nx">callback</span><span class="o">)</span> <span class="o">:</span> |
|
|
282 |
<span class="k">this</span><span class="o">.</span><span class="nx">_schedule</span><span class="o">(</span><span class="nx">callback</span><span class="o">);</span> |
|
|
283 |
<span class="o">}</span> |
|
|
284 |
|
|
|
285 |
<span class="k">if</span> <span class="o">(!</span><span class="nx">callback</span><span class="o">)</span> <span class="o">{</span> |
|
|
286 |
<span class="c">/**</span> |
|
|
287 |
<span class="c"> * Event fired after the last queued callback is executed.</span> |
|
|
288 |
<span class="c"> * @event complete</span> |
|
|
289 |
<span class="c"> */</span> |
|
|
290 |
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="s1">'complete'</span><span class="o">);</span> |
|
|
291 |
<span class="o">}</span> |
|
|
292 |
|
|
|
293 |
<span class="k">return</span> <span class="k">this</span><span class="o">;</span> |
|
|
294 |
<span class="o">},</span> |
|
|
295 |
|
|
|
296 |
<span class="c">/**</span> |
|
|
297 |
<span class="c"> * Handles the execution of callbacks. Returns a boolean indicating</span> |
|
|
298 |
<span class="c"> * whether it is appropriate to continue running.</span> |
|
|
299 |
<span class="c"> *</span> |
|
|
300 |
<span class="c"> * @method _execute</span> |
|
|
301 |
<span class="c"> * @param callback {Object} the callback object to execute</span> |
|
|
302 |
<span class="c"> * @return {Boolean} whether the run loop should continue</span> |
|
|
303 |
<span class="c"> * @protected</span> |
|
|
304 |
<span class="c"> */</span> |
|
|
305 |
<span class="nx">_execute</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">callback</span><span class="o">)</span> <span class="o">{</span> |
|
|
306 |
<span class="k">this</span><span class="o">.</span><span class="nx">_running</span> <span class="o">=</span> <span class="nx">callback</span><span class="o">.</span><span class="nx">_running</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> |
|
|
307 |
|
|
|
308 |
<span class="nx">callback</span><span class="o">.</span><span class="nx">iterations</span><span class="o">--;</span> |
|
|
309 |
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">EXECUTE</span><span class="o">,</span> <span class="o">{</span> <span class="nx">callback</span><span class="o">:</span> <span class="nx">callback</span> <span class="o">});</span> |
|
|
310 |
|
|
|
311 |
<span class="k">var</span> <span class="nx">cont</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_running</span> <span class="o">&&</span> <span class="nx">callback</span><span class="o">.</span><span class="nx">autoContinue</span><span class="o">;</span> |
|
|
312 |
|
|
|
313 |
<span class="k">this</span><span class="o">.</span><span class="nx">_running</span> <span class="o">=</span> <span class="nx">callback</span><span class="o">.</span><span class="nx">_running</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span> |
|
|
314 |
|
|
|
315 |
<span class="k">return</span> <span class="nx">cont</span><span class="o">;</span> |
|
|
316 |
<span class="o">},</span> |
|
|
317 |
|
|
|
318 |
<span class="c">/**</span> |
|
|
319 |
<span class="c"> * Schedules the execution of asynchronous callbacks.</span> |
|
|
320 |
<span class="c"> *</span> |
|
|
321 |
<span class="c"> * @method _schedule</span> |
|
|
322 |
<span class="c"> * @param callback {Object} the callback object to execute</span> |
|
|
323 |
<span class="c"> * @return {Boolean} whether the run loop should continue</span> |
|
|
324 |
<span class="c"> * @protected</span> |
|
|
325 |
<span class="c"> */</span> |
|
|
326 |
<span class="nx">_schedule</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">callback</span><span class="o">)</span> <span class="o">{</span> |
|
|
327 |
<span class="k">this</span><span class="o">.</span><span class="nx">_running</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">later</span><span class="o">(</span><span class="nx">callback</span><span class="o">.</span><span class="nx">timeout</span><span class="o">,</span> <span class="k">this</span><span class="o">,</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
328 |
<span class="k">if</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_execute</span><span class="o">(</span><span class="nx">callback</span><span class="o">))</span> <span class="o">{</span> |
|
|
329 |
<span class="k">this</span><span class="o">.</span><span class="nx">run</span><span class="o">();</span> |
|
|
330 |
<span class="o">}</span> |
|
|
331 |
<span class="o">});</span> |
|
|
332 |
|
|
|
333 |
<span class="k">return</span> <span class="kc">false</span><span class="o">;</span> |
|
|
334 |
<span class="o">},</span> |
|
|
335 |
|
|
|
336 |
<span class="c">/**</span> |
|
|
337 |
<span class="c"> * Determines if the queue is waiting for a callback to complete execution.</span> |
|
|
338 |
<span class="c"> *</span> |
|
|
339 |
<span class="c"> * @method isRunning</span> |
|
|
340 |
<span class="c"> * @return {Boolean} true if queue is waiting for a </span> |
|
|
341 |
<span class="c"> * from any initiated transactions</span> |
|
|
342 |
<span class="c"> */</span> |
|
|
343 |
<span class="nx">isRunning</span> <span class="o">:</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
344 |
<span class="k">return</span> <span class="o">!!</span><span class="k">this</span><span class="o">.</span><span class="nx">_running</span><span class="o">;</span> |
|
|
345 |
<span class="o">},</span> |
|
|
346 |
|
|
|
347 |
<span class="c">/**</span> |
|
|
348 |
<span class="c"> * Default functionality for the &quot;execute&quot; event. Executes the</span> |
|
|
349 |
<span class="c"> * callback function</span> |
|
|
350 |
<span class="c"> *</span> |
|
|
351 |
<span class="c"> * @method _defExecFn</span> |
|
|
352 |
<span class="c"> * @param e {Event} the event object</span> |
|
|
353 |
<span class="c"> * @protected</span> |
|
|
354 |
<span class="c"> */</span> |
|
|
355 |
<span class="nx">_defExecFn</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span> |
|
|
356 |
<span class="nx">e</span><span class="o">.</span><span class="nx">callback</span><span class="o">();</span> |
|
|
357 |
<span class="o">},</span> |
|
|
358 |
|
|
|
359 |
<span class="c">/**</span> |
|
|
360 |
<span class="c"> * Add any number of callbacks to the end of the queue. Callbacks may be</span> |
|
|
361 |
<span class="c"> * provided as functions or objects.</span> |
|
|
362 |
<span class="c"> *</span> |
|
|
363 |
<span class="c"> * @method add</span> |
|
|
364 |
<span class="c"> * @param callback* {Function|Object} 0..n callbacks</span> |
|
|
365 |
<span class="c"> * @return {AsyncQueue} the AsyncQueue instance</span> |
|
|
366 |
<span class="c"> * @chainable</span> |
|
|
367 |
<span class="c"> */</span> |
|
|
368 |
<span class="nx">add</span> <span class="o">:</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
369 |
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="s1">'add'</span><span class="o">,</span> <span class="o">{</span> <span class="nx">callbacks</span><span class="o">:</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">(</span><span class="nx">arguments</span><span class="o">,</span><span class="m">0</span><span class="o">,</span><span class="kc">true</span><span class="o">)</span> <span class="o">});</span> |
|
|
370 |
|
|
|
371 |
<span class="k">return</span> <span class="k">this</span><span class="o">;</span> |
|
|
372 |
<span class="o">},</span> |
|
|
373 |
|
|
|
374 |
<span class="c">/**</span> |
|
|
375 |
<span class="c"> * Default functionality for the &quot;add&quot; event. Adds the callbacks</span> |
|
|
376 |
<span class="c"> * in the event facade to the queue. Callbacks successfully added to the</span> |
|
|
377 |
<span class="c"> * queue are present in the event's <code>added</code> property in the</span> |
|
|
378 |
<span class="c"> * after phase.</span> |
|
|
379 |
<span class="c"> *</span> |
|
|
380 |
<span class="c"> * @method _defAddFn</span> |
|
|
381 |
<span class="c"> * @param e {Event} the event object</span> |
|
|
382 |
<span class="c"> * @protected</span> |
|
|
383 |
<span class="c"> */</span> |
|
|
384 |
<span class="nx">_defAddFn</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span> |
|
|
385 |
<span class="k">var</span> <span class="nx">_q</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_q</span><span class="o">,</span> |
|
|
386 |
<span class="nx">added</span> <span class="o">=</span> <span class="o">[];</span> |
|
|
387 |
|
|
|
388 |
<span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">callbacks</span><span class="o">,</span> <span class="k">function</span> <span class="o">(</span><span class="nx">c</span><span class="o">)</span> <span class="o">{</span> |
|
|
389 |
<span class="k">if</span> <span class="o">(</span><span class="nx">isObject</span><span class="o">(</span><span class="nx">c</span><span class="o">))</span> <span class="o">{</span> |
|
|
390 |
<span class="nx">_q</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">c</span><span class="o">);</span> |
|
|
391 |
<span class="nx">added</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">c</span><span class="o">);</span> |
|
|
392 |
<span class="o">}</span> |
|
|
393 |
<span class="o">});</span> |
|
|
394 |
|
|
|
395 |
<span class="nx">e</span><span class="o">.</span><span class="nx">added</span> <span class="o">=</span> <span class="nx">added</span><span class="o">;</span> |
|
|
396 |
<span class="o">},</span> |
|
|
397 |
|
|
|
398 |
<span class="c">/**</span> |
|
|
399 |
<span class="c"> * Pause the execution of the queue after the execution of the current</span> |
|
|
400 |
<span class="c"> * callback completes. If called from code outside of a queued callback,</span> |
|
|
401 |
<span class="c"> * clears the timeout for the pending callback. Paused queue can be</span> |
|
|
402 |
<span class="c"> * restarted with q.run()</span> |
|
|
403 |
<span class="c"> *</span> |
|
|
404 |
<span class="c"> * @method pause</span> |
|
|
405 |
<span class="c"> * @return {AsyncQueue} the AsyncQueue instance</span> |
|
|
406 |
<span class="c"> * @chainable</span> |
|
|
407 |
<span class="c"> */</span> |
|
|
408 |
<span class="nx">pause</span><span class="o">:</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
409 |
<span class="k">if</span> <span class="o">(</span><span class="nx">isObject</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_running</span><span class="o">))</span> <span class="o">{</span> |
|
|
410 |
<span class="k">this</span><span class="o">.</span><span class="nx">_running</span><span class="o">.</span><span class="nx">cancel</span><span class="o">();</span> |
|
|
411 |
<span class="o">}</span> |
|
|
412 |
|
|
|
413 |
<span class="k">this</span><span class="o">.</span><span class="nx">_running</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span> |
|
|
414 |
|
|
|
415 |
<span class="k">return</span> <span class="k">this</span><span class="o">;</span> |
|
|
416 |
<span class="o">},</span> |
|
|
417 |
|
|
|
418 |
<span class="c">/**</span> |
|
|
419 |
<span class="c"> * Stop and clear the queue after the current execution of the</span> |
|
|
420 |
<span class="c"> * current callback completes.</span> |
|
|
421 |
<span class="c"> *</span> |
|
|
422 |
<span class="c"> * @method stop</span> |
|
|
423 |
<span class="c"> * @return {AsyncQueue} the AsyncQueue instance</span> |
|
|
424 |
<span class="c"> * @chainable</span> |
|
|
425 |
<span class="c"> */</span> |
|
|
426 |
<span class="nx">stop</span> <span class="o">:</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
427 |
<span class="k">this</span><span class="o">.</span><span class="nx">_q</span> <span class="o">=</span> <span class="o">[];</span> |
|
|
428 |
|
|
|
429 |
<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">pause</span><span class="o">();</span> |
|
|
430 |
<span class="o">},</span> |
|
|
431 |
|
|
|
432 |
<span class="c">/** </span> |
|
|
433 |
<span class="c"> * Returns the current index of a callback. Pass in either the id or</span> |
|
|
434 |
<span class="c"> * callback function from getCallback.</span> |
|
|
435 |
<span class="c"> *</span> |
|
|
436 |
<span class="c"> * @method indexOf</span> |
|
|
437 |
<span class="c"> * @param callback {String|Function} the callback or its specified id</span> |
|
|
438 |
<span class="c"> * @return {Number} index of the callback or -1 if not found</span> |
|
|
439 |
<span class="c"> */</span> |
|
|
440 |
<span class="nx">indexOf</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">callback</span><span class="o">)</span> <span class="o">{</span> |
|
|
441 |
<span class="k">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="m">0</span><span class="o">,</span> <span class="nx">len</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_q</span><span class="o">.</span><span class="nx">length</span><span class="o">,</span> <span class="nx">c</span><span class="o">;</span> |
|
|
442 |
|
|
|
443 |
<span class="k">for</span> <span class="o">(;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">len</span><span class="o">;</span> <span class="o">++</span><span class="nx">i</span><span class="o">)</span> <span class="o">{</span> |
|
|
444 |
<span class="nx">c</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_q</span><span class="o">[</span><span class="nx">i</span><span class="o">];</span> |
|
|
445 |
<span class="k">if</span> <span class="o">(</span><span class="nx">c</span> <span class="o">===</span> <span class="nx">callback</span> <span class="o">||</span> <span class="nx">c</span><span class="o">.</span><span class="nx">id</span> <span class="o">===</span> <span class="nx">callback</span><span class="o">)</span> <span class="o">{</span> |
|
|
446 |
<span class="k">return</span> <span class="nx">i</span><span class="o">;</span> |
|
|
447 |
<span class="o">}</span> |
|
|
448 |
<span class="o">}</span> |
|
|
449 |
|
|
|
450 |
<span class="k">return</span> <span class="o">-</span><span class="m">1</span><span class="o">;</span> |
|
|
451 |
<span class="o">},</span> |
|
|
452 |
|
|
|
453 |
<span class="c">/**</span> |
|
|
454 |
<span class="c"> * Retrieve a callback by its id. Useful to modify the configuration</span> |
|
|
455 |
<span class="c"> * while the queue is running.</span> |
|
|
456 |
<span class="c"> *</span> |
|
|
457 |
<span class="c"> * @method getCallback</span> |
|
|
458 |
<span class="c"> * @param id {String} the id assigned to the callback</span> |
|
|
459 |
<span class="c"> * @return {Object} the callback object</span> |
|
|
460 |
<span class="c"> */</span> |
|
|
461 |
<span class="nx">getCallback</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">id</span><span class="o">)</span> <span class="o">{</span> |
|
|
462 |
<span class="k">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">indexOf</span><span class="o">(</span><span class="nx">id</span><span class="o">);</span> |
|
|
463 |
|
|
|
464 |
<span class="k">return</span> <span class="o">(</span><span class="nx">i</span> <span class="o">></span> <span class="o">-</span><span class="m">1</span><span class="o">)</span> <span class="o">?</span> <span class="k">this</span><span class="o">.</span><span class="nx">_q</span><span class="o">[</span><span class="nx">i</span><span class="o">]</span> <span class="o">:</span> <span class="kc">null</span><span class="o">;</span> |
|
|
465 |
<span class="o">},</span> |
|
|
466 |
|
|
|
467 |
<span class="c">/**</span> |
|
|
468 |
<span class="c"> * Promotes the named callback to the top of the queue. If a callback is</span> |
|
|
469 |
<span class="c"> * currently executing or looping (via until or iterations), the promotion</span> |
|
|
470 |
<span class="c"> * is scheduled to occur after the current callback has completed.</span> |
|
|
471 |
<span class="c"> *</span> |
|
|
472 |
<span class="c"> * @method promote</span> |
|
|
473 |
<span class="c"> * @param callback {String|Object} the callback object or a callback's id</span> |
|
|
474 |
<span class="c"> * @return {AsyncQueue} the AsyncQueue instance</span> |
|
|
475 |
<span class="c"> * @chainable</span> |
|
|
476 |
<span class="c"> */</span> |
|
|
477 |
<span class="nx">promote</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">callback</span><span class="o">)</span> <span class="o">{</span> |
|
|
478 |
<span class="k">var</span> <span class="nx">payload</span> <span class="o">=</span> <span class="o">{</span> <span class="nx">callback</span> <span class="o">:</span> <span class="nx">callback</span> <span class="o">},</span><span class="nx">e</span><span class="o">;</span> |
|
|
479 |
|
|
|
480 |
<span class="k">if</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">isRunning</span><span class="o">())</span> <span class="o">{</span> |
|
|
481 |
<span class="nx">e</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">after</span><span class="o">(</span><span class="nx">SHIFT</span><span class="o">,</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
482 |
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">PROMOTE</span><span class="o">,</span> <span class="nx">payload</span><span class="o">);</span> |
|
|
483 |
<span class="nx">e</span><span class="o">.</span><span class="nx">detach</span><span class="o">();</span> |
|
|
484 |
<span class="o">},</span> <span class="k">this</span><span class="o">);</span> |
|
|
485 |
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
|
486 |
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">PROMOTE</span><span class="o">,</span> <span class="nx">payload</span><span class="o">);</span> |
|
|
487 |
<span class="o">}</span> |
|
|
488 |
|
|
|
489 |
<span class="k">return</span> <span class="k">this</span><span class="o">;</span> |
|
|
490 |
<span class="o">},</span> |
|
|
491 |
|
|
|
492 |
<span class="c">/**</span> |
|
|
493 |
<span class="c"> * <p>Default functionality for the &quot;promote&quot; event. Promotes the</span> |
|
|
494 |
<span class="c"> * named callback to the head of the queue.</p></span> |
|
|
495 |
<span class="c"> *</span> |
|
|
496 |
<span class="c"> * <p>The event object will contain a property &quot;callback&quot;, which</span> |
|
|
497 |
<span class="c"> * holds the id of a callback or the callback object itself.</p></span> |
|
|
498 |
<span class="c"> *</span> |
|
|
499 |
<span class="c"> * @method _defPromoteFn</span> |
|
|
500 |
<span class="c"> * @param e {Event} the custom event</span> |
|
|
501 |
<span class="c"> * @protected</span> |
|
|
502 |
<span class="c"> */</span> |
|
|
503 |
<span class="nx">_defPromoteFn</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span> |
|
|
504 |
<span class="k">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">indexOf</span><span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">callback</span><span class="o">),</span> |
|
|
505 |
<span class="nx">promoted</span> <span class="o">=</span> <span class="o">(</span><span class="nx">i</span> <span class="o">></span> <span class="o">-</span><span class="m">1</span><span class="o">)</span> <span class="o">?</span> <span class="k">this</span><span class="o">.</span><span class="nx">_q</span><span class="o">.</span><span class="nx">splice</span><span class="o">(</span><span class="nx">i</span><span class="o">,</span><span class="m">1</span><span class="o">)[</span><span class="m">0</span><span class="o">]</span> <span class="o">:</span> <span class="kc">null</span><span class="o">;</span> |
|
|
506 |
|
|
|
507 |
<span class="nx">e</span><span class="o">.</span><span class="nx">promoted</span> <span class="o">=</span> <span class="nx">promoted</span><span class="o">;</span> |
|
|
508 |
|
|
|
509 |
<span class="k">if</span> <span class="o">(</span><span class="nx">promoted</span><span class="o">)</span> <span class="o">{</span> |
|
|
510 |
<span class="k">this</span><span class="o">.</span><span class="nx">_q</span><span class="o">.</span><span class="nx">unshift</span><span class="o">(</span><span class="nx">promoted</span><span class="o">);</span> |
|
|
511 |
<span class="o">}</span> |
|
|
512 |
<span class="o">},</span> |
|
|
513 |
|
|
|
514 |
<span class="c">/**</span> |
|
|
515 |
<span class="c"> * Removes the callback from the queue. If the queue is active, the</span> |
|
|
516 |
<span class="c"> * removal is scheduled to occur after the current callback has completed.</span> |
|
|
517 |
<span class="c"> *</span> |
|
|
518 |
<span class="c"> * @method remove</span> |
|
|
519 |
<span class="c"> * @param callback {String|Object} the callback object or a callback's id</span> |
|
|
520 |
<span class="c"> * @return {AsyncQueue} the AsyncQueue instance</span> |
|
|
521 |
<span class="c"> * @chainable</span> |
|
|
522 |
<span class="c"> */</span> |
|
|
523 |
<span class="nx">remove</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">callback</span><span class="o">)</span> <span class="o">{</span> |
|
|
524 |
<span class="k">var</span> <span class="nx">payload</span> <span class="o">=</span> <span class="o">{</span> <span class="nx">callback</span> <span class="o">:</span> <span class="nx">callback</span> <span class="o">},</span><span class="nx">e</span><span class="o">;</span> |
|
|
525 |
|
|
|
526 |
<span class="c">// Can't return the removed callback because of the deferral until</span> |
|
|
527 |
<span class="c"></span> <span class="c">// current callback is complete</span> |
|
|
528 |
<span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">isRunning</span><span class="o">())</span> <span class="o">{</span> |
|
|
529 |
<span class="nx">e</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">after</span><span class="o">(</span><span class="nx">SHIFT</span><span class="o">,</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
530 |
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">REMOVE</span><span class="o">,</span> <span class="nx">payload</span><span class="o">);</span> |
|
|
531 |
<span class="nx">e</span><span class="o">.</span><span class="nx">detach</span><span class="o">();</span> |
|
|
532 |
<span class="o">},</span><span class="k">this</span><span class="o">);</span> |
|
|
533 |
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
|
534 |
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">REMOVE</span><span class="o">,</span> <span class="nx">payload</span><span class="o">);</span> |
|
|
535 |
<span class="o">}</span> |
|
|
536 |
|
|
|
537 |
<span class="k">return</span> <span class="k">this</span><span class="o">;</span> |
|
|
538 |
<span class="o">},</span> |
|
|
539 |
|
|
|
540 |
<span class="c">/**</span> |
|
|
541 |
<span class="c"> * <p>Default functionality for the &quot;remove&quot; event. Removes the</span> |
|
|
542 |
<span class="c"> * callback from the queue.</p></span> |
|
|
543 |
<span class="c"> *</span> |
|
|
544 |
<span class="c"> * <p>The event object will contain a property &quot;callback&quot;, which</span> |
|
|
545 |
<span class="c"> * holds the id of a callback or the callback object itself.</p></span> |
|
|
546 |
<span class="c"> *</span> |
|
|
547 |
<span class="c"> * @method _defRemoveFn</span> |
|
|
548 |
<span class="c"> * @param e {Event} the custom event</span> |
|
|
549 |
<span class="c"> * @protected</span> |
|
|
550 |
<span class="c"> */</span> |
|
|
551 |
<span class="nx">_defRemoveFn</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span> |
|
|
552 |
<span class="k">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">indexOf</span><span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">callback</span><span class="o">);</span> |
|
|
553 |
|
|
|
554 |
<span class="nx">e</span><span class="o">.</span><span class="nx">removed</span> <span class="o">=</span> <span class="o">(</span><span class="nx">i</span> <span class="o">></span> <span class="o">-</span><span class="m">1</span><span class="o">)</span> <span class="o">?</span> <span class="k">this</span><span class="o">.</span><span class="nx">_q</span><span class="o">.</span><span class="nx">splice</span><span class="o">(</span><span class="nx">i</span><span class="o">,</span><span class="m">1</span><span class="o">)[</span><span class="m">0</span><span class="o">]</span> <span class="o">:</span> <span class="kc">null</span><span class="o">;</span> |
|
|
555 |
<span class="o">},</span> |
|
|
556 |
|
|
|
557 |
<span class="c">/**</span> |
|
|
558 |
<span class="c"> * Returns the number of callbacks in the queue.</span> |
|
|
559 |
<span class="c"> *</span> |
|
|
560 |
<span class="c"> * @method size</span> |
|
|
561 |
<span class="c"> * @return {Number}</span> |
|
|
562 |
<span class="c"> */</span> |
|
|
563 |
<span class="nx">size</span> <span class="o">:</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
|
564 |
<span class="c">// next() flushes callbacks that have met their until() criteria and</span> |
|
|
565 |
<span class="c"></span> <span class="c">// therefore shouldn't count since they wouldn't execute anyway.</span> |
|
|
566 |
<span class="c"></span> <span class="k">if</span> <span class="o">(!</span><span class="k">this</span><span class="o">.</span><span class="nx">isRunning</span><span class="o">())</span> <span class="o">{</span> |
|
|
567 |
<span class="k">this</span><span class="o">.</span><span class="nx">next</span><span class="o">();</span> |
|
|
568 |
<span class="o">}</span> |
|
|
569 |
|
|
|
570 |
<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_q</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> |
|
|
571 |
<span class="o">}</span> |
|
|
572 |
<span class="o">});</span> |
|
|
573 |
</pre></div> |
|
|
574 |
|
|
|
575 |
</div> |
|
|
576 |
</div> |
|
|
577 |
</div> |
|
|
578 |
<div class="yui-b"> |
|
|
579 |
<div class="nav"> |
|
|
580 |
|
|
|
581 |
<div id="moduleList" class="module"> |
|
|
582 |
<h4>Modules</h4> |
|
|
583 |
<ul class="content"> |
|
|
584 |
<li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
|
585 |
<li class="selected"><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
|
586 |
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
|
587 |
<li class=""><a href="module_base.html" title="base">base</a></li> |
|
|
588 |
<li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
|
589 |
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
|
590 |
<li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
|
591 |
<li class=""><a href="module_console.html" title="console">console</a></li> |
|
|
592 |
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
|
593 |
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
|
594 |
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
|
595 |
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
|
596 |
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
|
597 |
<li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
|
598 |
<li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
|
599 |
<li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
|
600 |
<li class=""><a href="module_event.html" title="event">event</a></li> |
|
|
601 |
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
|
602 |
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
|
603 |
<li class=""><a href="module_history.html" title="history">history</a></li> |
|
|
604 |
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
|
605 |
<li class=""><a href="module_io.html" title="io">io</a></li> |
|
|
606 |
<li class=""><a href="module_json.html" title="json">json</a></li> |
|
|
607 |
<li class=""><a href="module_node.html" title="node">node</a></li> |
|
|
608 |
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
|
609 |
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
|
610 |
<li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
|
611 |
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
|
612 |
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
|
613 |
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
|
614 |
<li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
|
615 |
<li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
|
616 |
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
|
617 |
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
|
618 |
<li class=""><a href="module_test.html" title="test">test</a></li> |
|
|
619 |
<li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
|
620 |
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
|
621 |
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
|
622 |
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
|
623 |
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
|
624 |
<li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
|
625 |
</ul> |
|
|
626 |
</div> |
|
|
627 |
|
|
|
628 |
<div id="classList" class="module"> |
|
|
629 |
<h4>Classes</h4> |
|
|
630 |
<ul class="content"> |
|
|
631 |
<li class=""><a href="AsyncQueue.html" title="AsyncQueue">AsyncQueue</a></li> |
|
|
632 |
</ul> |
|
|
633 |
</div> |
|
|
634 |
|
|
|
635 |
<div id="fileList" class="module"> |
|
|
636 |
<h4>Files</h4> |
|
|
637 |
<ul class="content"> |
|
|
638 |
<li class="selected"><a href="async-queue.js.html" title="async-queue.js">async-queue.js</a></li> |
|
|
639 |
</ul> |
|
|
640 |
</div> |
|
|
641 |
|
|
|
642 |
|
|
|
643 |
|
|
|
644 |
|
|
|
645 |
|
|
|
646 |
</div> |
|
|
647 |
</div> |
|
|
648 |
</div> |
|
|
649 |
<div id="ft"> |
|
|
650 |
<hr /> |
|
|
651 |
Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
|
652 |
</div> |
|
|
653 |
</div> |
|
|
654 |
<script type="text/javascript"> |
|
|
655 |
ALL_YUI_PROPS = [{"access": "", "host": "AsyncQueue", "name": "add", "url": "AsyncQueue.html#method_add", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "AsyncQueue.defaults", "url": "AsyncQueue.html#property_AsyncQueue.defaults", "type": "property"}, {"access": "", "host": "AsyncQueue", "name": "complete", "url": "AsyncQueue.html#event_complete", "type": "event"}, {"access": "protected", "host": "AsyncQueue", "name": "_defAddFn", "url": "AsyncQueue.html#method__defAddFn", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "defaults", "url": "AsyncQueue.html#property_defaults", "type": "property"}, {"access": "protected", "host": "AsyncQueue", "name": "_defExecFn", "url": "AsyncQueue.html#method__defExecFn", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_defPromoteFn", "url": "AsyncQueue.html#method__defPromoteFn", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_defRemoveFn", "url": "AsyncQueue.html#method__defRemoveFn", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_defShiftFn", "url": "AsyncQueue.html#method__defShiftFn", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_execute", "url": "AsyncQueue.html#method__execute", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "getCallback", "url": "AsyncQueue.html#method_getCallback", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "indexOf", "url": "AsyncQueue.html#method_indexOf", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_init", "url": "AsyncQueue.html#method__init", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_initEvents", "url": "AsyncQueue.html#method__initEvents", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "isRunning", "url": "AsyncQueue.html#method_isRunning", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "next", "url": "AsyncQueue.html#method_next", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "pause", "url": "AsyncQueue.html#method_pause", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_prepare", "url": "AsyncQueue.html#method__prepare", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "promote", "url": "AsyncQueue.html#method_promote", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "remove", "url": "AsyncQueue.html#method_remove", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "run", "url": "AsyncQueue.html#method_run", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_running", "url": "AsyncQueue.html#property__running", "type": "property"}, {"access": "protected", "host": "AsyncQueue", "name": "_schedule", "url": "AsyncQueue.html#method__schedule", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "size", "url": "AsyncQueue.html#method_size", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "stop", "url": "AsyncQueue.html#method_stop", "type": "method"}]; |
|
|
656 |
</script> |
|
|
657 |
</body> |
|
|
658 |
</html> |