-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathqueue.js.html
More file actions
359 lines (340 loc) · 17.7 KB
/
Copy pathqueue.js.html
File metadata and controls
359 lines (340 loc) · 17.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
<!DOCTYPE html>
<html>
<head>
<title>queue.js</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="stylesheet" media="all" href="../doc-style.css" />
<script src="../doc-filelist.js"></script>
<script>
var relativeDir = '../', thisFile = 'lib/queue.js', defaultSidebar = true;
</script>
<script src="../doc-script.js"></script>
</head>
<body>
<div id="sidebar_wrapper">
<div id="sidebar_switch">
<span class="tree">Files</span>
<span class="headings">Headings</span>
</div>
<div id="tree"></div>
<div id="headings">
<div class="heading h1">
<a href="#queue">QUEUE</a>
</div>
<div class="heading h2">
<a href="#queue-constructor">Queue constructor</a>
</div>
<div class="heading h3">
<a href="#queue.queue">Queue.queue</a>
</div>
<div class="heading h3">
<a href="#queue.inprogress">Queue.inProgress</a>
</div>
<div class="heading h3">
<a href="#queue.isready">Queue.isReady</a>
</div>
<div class="heading h3">
<a href="#queue.onready">Queue.onReady</a>
</div>
<div class="heading h3">
<a href="#queue.add">Queue.add</a>
</div>
<div class="heading h3">
<a href="#queue.remove">Queue.remove</a>
</div>
<div class="heading h3">
<a href="#queue.getremovecb">Queue.getRemoveCb</a>
</div>
<div class="heading h3">
<a href="#queue.executeandclear">Queue.executeAndClear</a>
</div>
</div>
</div>
<div id="sidebar-toggle"></div>
<div id="container"><div class="background highlight"></div>
<table cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="docs"><div class="dox">
<div class="summary">
<div class="pilwrap" id="queue">
<h1>
<a href="#queue" class="pilcrow">¶</a>
QUEUE
</h1>
</div>
<p>Copyright(c) 2015 Stefano Balietti
MIT Licensed</p>
</div>
<div class="body"><p>Handles a simple queue of operations</p>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">JSUS</span><span class="p">)</span> <span class="p">{</span>
<span class="s2">"use strict"</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">QUEUE</span> <span class="o">=</span> <span class="p">{};</span>
<span class="nx">QUEUE</span><span class="p">.</span><span class="nx">getQueue</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="k">return</span> <span class="k">new</span> <span class="nx">Queue</span><span class="p">();</span>
<span class="p">};</span></pre></div>
</td>
</tr>
<tr>
<td class="docs"><div class="dox">
<div class="summary">
<div class="pilwrap" id="queue-constructor">
<h2>
<a href="#queue-constructor" class="pilcrow">¶</a>
Queue constructor
</h2>
</div>
</div>
<div class="body">
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre> <span class="kd">function</span> <span class="nx">Queue</span><span class="p">()</span> <span class="p">{</span></pre></div>
</td>
</tr>
<tr>
<td class="docs"><div class="dox">
<div class="summary">
<div class="pilwrap" id="queue.queue">
<h3>
<a href="#queue.queue" class="pilcrow">¶</a>
Queue.queue
</h3>
</div>
</div>
<div class="body"><p>The list of functions waiting to be executed.</p>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre> <span class="k">this</span><span class="p">.</span><span class="nx">queue</span> <span class="o">=</span> <span class="p">[];</span></pre></div>
</td>
</tr>
<tr>
<td class="docs"><div class="dox">
<div class="summary">
<div class="pilwrap" id="queue.inprogress">
<h3>
<a href="#queue.inprogress" class="pilcrow">¶</a>
Queue.inProgress
</h3>
</div>
</div>
<div class="body"><p>The list of operations ids currently in progress.</p>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre> <span class="k">this</span><span class="p">.</span><span class="nx">inProgress</span> <span class="o">=</span> <span class="p">{};</span>
<span class="p">}</span></pre></div>
</td>
</tr>
<tr>
<td class="docs"><div class="dox">
<div class="summary">
<div class="pilwrap" id="queue.isready">
<h3>
<a href="#queue.isready" class="pilcrow">¶</a>
Queue.isReady
</h3>
</div>
</div>
<div class="body"><p>Returns TRUE if no operation is in progress</p>
</div>
<div class="details">
<div class="dox_tag_title">Returns</div>
<div class="dox_tag_detail">
<span class="dox_tag_name"></span>
<span class="dox_type">boolean</span>
<span>TRUE, if no operation is in progress</span>
</div>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre> <span class="nx">Queue</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">isReady</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">JSUS</span><span class="p">.</span><span class="nx">isEmpty</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">inProgress</span><span class="p">);</span>
<span class="p">};</span></pre></div>
</td>
</tr>
<tr>
<td class="docs"><div class="dox">
<div class="summary">
<div class="pilwrap" id="queue.onready">
<h3>
<a href="#queue.onready" class="pilcrow">¶</a>
Queue.onReady
</h3>
</div>
</div>
<div class="body"><p>Executes the specified callback once the queue has been cleared</p>
<p>Multiple functions to execute can be added, and they are executed
sequentially once the queue is cleared.</p>
<p>If the queue is already cleared, the function is executed immediately.</p>
</div>
<div class="details">
<div class="dox_tag_title">Params</div>
<div class="dox_tag_detail">
<span class="dox_tag_name">cb</span>
<span class="dox_type">function</span>
<span>The callback to execute</span>
</div>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre> <span class="nx">Queue</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">onReady</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">cb</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="s1">'function'</span> <span class="o">!==</span> <span class="k">typeof</span> <span class="nx">cb</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nx">TypeError</span><span class="p">(</span><span class="s1">'Queue.onReady: cb must be function. Found: '</span> <span class="o">+</span>
<span class="nx">cb</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">JSUS</span><span class="p">.</span><span class="nx">isEmpty</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">inProgress</span><span class="p">))</span> <span class="nx">cb</span><span class="p">();</span>
<span class="k">else</span> <span class="k">this</span><span class="p">.</span><span class="nx">queue</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">cb</span><span class="p">);</span>
<span class="p">};</span></pre></div>
</td>
</tr>
<tr>
<td class="docs"><div class="dox">
<div class="summary">
<div class="pilwrap" id="queue.add">
<h3>
<a href="#queue.add" class="pilcrow">¶</a>
Queue.add
</h3>
</div>
</div>
<div class="body"><p>Adds an item to the <em>inProgress</em> index</p>
</div>
<div class="details">
<div class="dox_tag_title">Params</div>
<div class="dox_tag_detail">
<span class="dox_tag_name">key</span>
<span class="dox_type">string</span>
<span>A tentative key name</span>
</div>
<div class="dox_tag_title">Returns</div>
<div class="dox_tag_detail">
<span class="dox_tag_name"></span>
<span class="dox_type">string</span>
<span>The unique key to be used to unregister the operation</span>
</div>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre> <span class="nx">Queue</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">add</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">key</span> <span class="o">&&</span> <span class="s1">'string'</span> <span class="o">!==</span> <span class="k">typeof</span> <span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'Queue.add: key must be string.'</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">key</span> <span class="o">=</span> <span class="nx">JSUS</span><span class="p">.</span><span class="nx">uniqueKey</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">inProgress</span><span class="p">,</span> <span class="nx">key</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="s1">'string'</span> <span class="o">!==</span> <span class="k">typeof</span> <span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'Queue.add: an error occurred '</span> <span class="o">+</span>
<span class="s1">'generating unique key.'</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">this</span><span class="p">.</span><span class="nx">inProgress</span><span class="p">[</span><span class="nx">key</span><span class="p">]</span> <span class="o">=</span> <span class="nx">key</span><span class="p">;</span>
<span class="k">return</span> <span class="nx">key</span><span class="p">;</span>
<span class="p">};</span></pre></div>
</td>
</tr>
<tr>
<td class="docs"><div class="dox">
<div class="summary">
<div class="pilwrap" id="queue.remove">
<h3>
<a href="#queue.remove" class="pilcrow">¶</a>
Queue.remove
</h3>
</div>
</div>
<div class="body"><p>Remove a specified key from the <em>inProgress</em> index</p>
</div>
<div class="details">
<div class="dox_tag_title">Params</div>
<div class="dox_tag_detail">
<span class="dox_tag_name">key</span>
<span class="dox_type">string</span>
<span>The key to remove from the <em>inProgress</em> index.</span>
</div>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre> <span class="nx">Queue</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">remove</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="s1">'string'</span> <span class="o">!==</span> <span class="k">typeof</span> <span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'Queue.remove: key must be string.'</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">delete</span> <span class="k">this</span><span class="p">.</span><span class="nx">inProgress</span><span class="p">[</span><span class="nx">key</span><span class="p">];</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">JSUS</span><span class="p">.</span><span class="nx">isEmpty</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">inProgress</span><span class="p">))</span> <span class="p">{</span>
<span class="k">this</span><span class="p">.</span><span class="nx">executeAndClear</span><span class="p">();</span>
<span class="p">}</span>
<span class="p">};</span></pre></div>
</td>
</tr>
<tr>
<td class="docs"><div class="dox">
<div class="summary">
<div class="pilwrap" id="queue.getremovecb">
<h3>
<a href="#queue.getremovecb" class="pilcrow">¶</a>
Queue.getRemoveCb
</h3>
</div>
</div>
<div class="body"><p>Returns a callback to remove an item from the <em>inProgress</em> index</p>
<p>This method is useful when the callbacks is defined inside loops,
so that a closure is created around the variable key.</p>
</div>
<div class="details">
<div class="dox_tag_title">Params</div>
<div class="dox_tag_detail">
<span class="dox_tag_name">key</span>
<span class="dox_type">string</span>
<span>The key to remove from the <em>inProgress</em> index.</span>
</div>
<div class="dox_tag_title">See</div>
<div class="dox_tag_detail">
<span class="dox_type">Queue.remove
</span>
</div>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre> <span class="nx">Queue</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">getRemoveCb</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">that</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="s1">'string'</span> <span class="o">!==</span> <span class="k">typeof</span> <span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'Queue.getRemoveCb: key must be string.'</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">that</span> <span class="o">=</span> <span class="k">this</span><span class="p">;</span>
<span class="k">return</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span> <span class="nx">that</span><span class="p">.</span><span class="nx">remove</span><span class="p">(</span><span class="nx">key</span><span class="p">);</span> <span class="p">};</span>
<span class="p">};</span></pre></div>
</td>
</tr>
<tr>
<td class="docs"><div class="dox">
<div class="summary">
<div class="pilwrap" id="queue.executeandclear">
<h3>
<a href="#queue.executeandclear" class="pilcrow">¶</a>
Queue.executeAndClear
</h3>
</div>
</div>
<div class="body"><p>Executes sequentially all callbacks, and removes them from the queue</p>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre> <span class="nx">Queue</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">executeAndClear</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">i</span><span class="p">,</span> <span class="nx">len</span><span class="p">;</span>
<span class="nx">i</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span><span class="p">;</span>
<span class="nx">len</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">queue</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span>
<span class="k">for</span> <span class="p">(</span> <span class="p">;</span> <span class="o">++</span><span class="nx">i</span> <span class="o"><</span> <span class="nx">len</span> <span class="p">;</span> <span class="p">)</span> <span class="p">{</span>
<span class="k">this</span><span class="p">.</span><span class="nx">queue</span><span class="p">[</span><span class="nx">i</span><span class="p">]();</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">JSUS</span><span class="p">.</span><span class="nx">extend</span><span class="p">(</span><span class="nx">QUEUE</span><span class="p">);</span>
<span class="p">})(</span><span class="s1">'undefined'</span> <span class="o">!==</span> <span class="k">typeof</span> <span class="nx">JSUS</span> <span class="o">?</span> <span class="nx">JSUS</span> <span class="o">:</span> <span class="nx">module</span><span class="p">.</span><span class="nx">parent</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">JSUS</span><span class="p">);</span>
</pre></div>
</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>