disbatch 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1043 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Disbatch::Queue
8
+
9
+ &mdash; Documentation by YARD 0.7.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (Q)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Disbatch.html" title="Disbatch (module)">Disbatch</a></span></span>
38
+ &raquo;
39
+ <span class="title">Queue</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Class: Disbatch::Queue
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+ <dt class="r1">Inherits:</dt>
68
+ <dd class="r1">
69
+ <span class="inheritName">Object</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">Disbatch::Queue</li>
75
+
76
+ </ul>
77
+ <a href="#" class="inheritanceTree">show all</a>
78
+
79
+ </dd>
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+ <dt class="r2 last">Defined in:</dt>
90
+ <dd class="r2 last">lib/disbatch/queue.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+ <h2>Overview</h2><div class="docstring">
96
+ <div class="discussion">
97
+ <p>
98
+ Represents a Disbatch queue
99
+ </p>
100
+
101
+
102
+ </div>
103
+ </div>
104
+ <div class="tags">
105
+
106
+
107
+ </div><h2>Defined Under Namespace</h2>
108
+ <p class="children">
109
+
110
+
111
+
112
+
113
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Queue/Task.html" title="Disbatch::Queue::Task (class)">Task</a></span>
114
+
115
+
116
+ </p>
117
+
118
+
119
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
120
+ <ul class="summary">
121
+
122
+ <li class="public ">
123
+ <span class="summary_signature">
124
+
125
+ <a href="#id-instance_method" title="#id (instance method)">- (Object) <strong>id</strong> </a>
126
+
127
+
128
+
129
+ </span>
130
+
131
+
132
+ <span class="note title readonly">readonly</span>
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <span class="summary_desc"><div class='inline'><p>
142
+ Returns the value of attribute id.
143
+ </p>
144
+ </div></span>
145
+
146
+ </li>
147
+
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#plugin-instance_method" title="#plugin (instance method)">- (Object) <strong>plugin</strong> </a>
153
+
154
+
155
+
156
+ </span>
157
+
158
+
159
+ <span class="note title readonly">readonly</span>
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+ <span class="summary_desc"><div class='inline'><p>
169
+ Returns the value of attribute plugin.
170
+ </p>
171
+ </div></span>
172
+
173
+ </li>
174
+
175
+
176
+ </ul>
177
+
178
+
179
+
180
+
181
+
182
+ <h2>
183
+ Class Method Summary
184
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
185
+ </h2>
186
+
187
+ <ul class="summary">
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#create-class_method" title="create (class method)">+ (Object) <strong>create</strong>(plugin, opts = {}) </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <span class="summary_desc"><div class='inline'><p>
206
+ Create a new queue.
207
+ </p>
208
+ </div></span>
209
+
210
+ </li>
211
+
212
+
213
+ <li class="public ">
214
+ <span class="summary_signature">
215
+
216
+ <a href="#get-class_method" title="get (class method)">+ (Object) <strong>get</strong>(id) </a>
217
+
218
+
219
+
220
+ </span>
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+ <span class="summary_desc"><div class='inline'><p>
230
+ Get an existing queue.
231
+ </p>
232
+ </div></span>
233
+
234
+ </li>
235
+
236
+
237
+ <li class="public ">
238
+ <span class="summary_signature">
239
+
240
+ <a href="#get_all-class_method" title="get_all (class method)">+ (Object) <strong>get_all</strong> </a>
241
+
242
+
243
+
244
+ </span>
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+ <span class="summary_desc"><div class='inline'><p>
254
+ Get all existing queues.
255
+ </p>
256
+ </div></span>
257
+
258
+ </li>
259
+
260
+
261
+ </ul>
262
+
263
+ <h2>
264
+ Instance Method Summary
265
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
266
+ </h2>
267
+
268
+ <ul class="summary">
269
+
270
+ <li class="public ">
271
+ <span class="summary_signature">
272
+
273
+ <a href="#%3D%3D-instance_method" title="#== (instance method)">- (Object) <strong>==</strong>(queue) </a>
274
+
275
+
276
+
277
+ </span>
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+ <span class="summary_desc"><div class='inline'><p>
287
+ Check equality with another queue object.
288
+ </p>
289
+ </div></span>
290
+
291
+ </li>
292
+
293
+
294
+ <li class="public ">
295
+ <span class="summary_signature">
296
+
297
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Queue) <strong>initialize</strong>(plugin, id) </a>
298
+
299
+
300
+
301
+ </span>
302
+
303
+ <span class="note title constructor">constructor</span>
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+ <span class="summary_desc"><div class='inline'><p>
313
+ Create a queue object.
314
+ </p>
315
+ </div></span>
316
+
317
+ </li>
318
+
319
+
320
+ <li class="public ">
321
+ <span class="summary_signature">
322
+
323
+ <a href="#length-instance_method" title="#length (instance method)">- (Object) <strong>length</strong> </a>
324
+
325
+
326
+
327
+ (also: #size)
328
+
329
+ </span>
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+ <span class="summary_desc"><div class='inline'><p>
339
+ Number of pending tasks.
340
+ </p>
341
+ </div></span>
342
+
343
+ </li>
344
+
345
+
346
+ <li class="public ">
347
+ <span class="summary_signature">
348
+
349
+ <a href="#pop-instance_method" title="#pop (instance method)">- (Object) <strong>pop</strong> </a>
350
+
351
+
352
+
353
+ </span>
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+ <span class="summary_desc"><div class='inline'><p>
363
+ Pop a task off the queue.
364
+ </p>
365
+ </div></span>
366
+
367
+ </li>
368
+
369
+
370
+ <li class="public ">
371
+ <span class="summary_signature">
372
+
373
+ <a href="#push-instance_method" title="#push (instance method)">- (Object) <strong>push</strong>(parameters) </a>
374
+
375
+
376
+
377
+ </span>
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+ <span class="summary_desc"><div class='inline'><p>
387
+ Push a new task onto the queue.
388
+ </p>
389
+ </div></span>
390
+
391
+ </li>
392
+
393
+
394
+ </ul>
395
+
396
+
397
+ <div id="constructor_details" class="method_details_list">
398
+ <h2>Constructor Details</h2>
399
+
400
+ <div class="method_details first">
401
+ <p class="signature first" id="initialize-instance_method">
402
+
403
+ - (<tt><span class='object_link'><a href="" title="Disbatch::Queue (class)">Queue</a></span></tt>) <strong>initialize</strong>(plugin, id)
404
+
405
+
406
+
407
+ </p><div class="docstring">
408
+ <div class="discussion">
409
+ <p>
410
+ Create a queue object
411
+ </p>
412
+
413
+
414
+ </div>
415
+ </div>
416
+ <div class="tags">
417
+ <h3>Parameters:</h3>
418
+ <ul class="param">
419
+
420
+ <li>
421
+
422
+ <span class='name'>plugin</span>
423
+
424
+
425
+ <span class='type'>(<tt>String</tt>)</span>
426
+
427
+
428
+
429
+ </li>
430
+
431
+ <li>
432
+
433
+ <span class='name'>id</span>
434
+
435
+
436
+ <span class='type'>(<tt>String</tt>)</span>
437
+
438
+
439
+
440
+ </li>
441
+
442
+ </ul>
443
+
444
+
445
+ </div><table class="source_code">
446
+ <tr>
447
+ <td>
448
+ <pre class="lines">
449
+
450
+
451
+ 14
452
+ 15
453
+ 16
454
+ 17</pre>
455
+ </td>
456
+ <td>
457
+ <pre class="code"><span class="info file"># File 'lib/disbatch/queue.rb', line 14</span>
458
+
459
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='plugin identifier id'>plugin</span><span class='comma token'>,</span> <span class='id identifier id'>id</span><span class='rparen token'>)</span>
460
+ <span class='@id ivar id'>@id</span> <span class='assign token'>=</span> <span class='id identifier id'>id</span>
461
+ <span class='@plugin ivar id'>@plugin</span> <span class='assign token'>=</span> <span class='plugin identifier id'>plugin</span>
462
+ <span class='end end kw'>end</span>
463
+ </pre>
464
+ </td>
465
+ </tr>
466
+ </table>
467
+ </div>
468
+
469
+ </div>
470
+
471
+ <div id="instance_attr_details" class="attr_details">
472
+ <h2>Instance Attribute Details</h2>
473
+
474
+
475
+ <span id=""></span>
476
+ <span id="id-instance_method"></span>
477
+ <div class="method_details first">
478
+ <p class="signature first" id="id-instance_method">
479
+
480
+ - (<tt>Object</tt>) <strong>id</strong> <span class="extras">(readonly)</span>
481
+
482
+
483
+
484
+ </p><div class="docstring">
485
+ <div class="discussion">
486
+ <p>
487
+ Returns the value of attribute id
488
+ </p>
489
+
490
+
491
+ </div>
492
+ </div>
493
+ <div class="tags">
494
+
495
+
496
+ </div><table class="source_code">
497
+ <tr>
498
+ <td>
499
+ <pre class="lines">
500
+
501
+
502
+ 6
503
+ 7
504
+ 8</pre>
505
+ </td>
506
+ <td>
507
+ <pre class="code"><span class="info file"># File 'lib/disbatch/queue.rb', line 6</span>
508
+
509
+ <span class='def def kw'>def</span> <span class='id identifier id'>id</span>
510
+ <span class='@id ivar id'>@id</span>
511
+ <span class='end end kw'>end</span>
512
+ </pre>
513
+ </td>
514
+ </tr>
515
+ </table>
516
+ </div>
517
+
518
+
519
+ <span id=""></span>
520
+ <span id="plugin-instance_method"></span>
521
+ <div class="method_details ">
522
+ <p class="signature " id="plugin-instance_method">
523
+
524
+ - (<tt>Object</tt>) <strong>plugin</strong> <span class="extras">(readonly)</span>
525
+
526
+
527
+
528
+ </p><div class="docstring">
529
+ <div class="discussion">
530
+ <p>
531
+ Returns the value of attribute plugin
532
+ </p>
533
+
534
+
535
+ </div>
536
+ </div>
537
+ <div class="tags">
538
+
539
+
540
+ </div><table class="source_code">
541
+ <tr>
542
+ <td>
543
+ <pre class="lines">
544
+
545
+
546
+ 6
547
+ 7
548
+ 8</pre>
549
+ </td>
550
+ <td>
551
+ <pre class="code"><span class="info file"># File 'lib/disbatch/queue.rb', line 6</span>
552
+
553
+ <span class='def def kw'>def</span> <span class='plugin identifier id'>plugin</span>
554
+ <span class='@plugin ivar id'>@plugin</span>
555
+ <span class='end end kw'>end</span>
556
+ </pre>
557
+ </td>
558
+ </tr>
559
+ </table>
560
+ </div>
561
+
562
+ </div>
563
+
564
+
565
+ <div id="class_method_details" class="method_details_list">
566
+ <h2>Class Method Details</h2>
567
+
568
+
569
+ <div class="method_details first">
570
+ <p class="signature first" id="create-class_method">
571
+
572
+ + (<tt>Object</tt>) <strong>create</strong>(plugin, opts = {})
573
+
574
+
575
+
576
+ </p><div class="docstring">
577
+ <div class="discussion">
578
+ <p>
579
+ Create a new queue
580
+ </p>
581
+
582
+
583
+ </div>
584
+ </div>
585
+ <div class="tags">
586
+ <h3>Parameters:</h3>
587
+ <ul class="param">
588
+
589
+ <li>
590
+
591
+ <span class='name'>plugin</span>
592
+
593
+
594
+ <span class='type'>(<tt>String</tt>)</span>
595
+
596
+
597
+
598
+ </li>
599
+
600
+ <li>
601
+
602
+ <span class='name'>opts</span>
603
+
604
+
605
+ <span class='type'>(<tt>Hash</tt>)</span>
606
+
607
+
608
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
609
+
610
+
611
+ </li>
612
+
613
+ </ul>
614
+
615
+
616
+
617
+
618
+
619
+
620
+ <h3>Options Hash (<tt>opts</tt>):</h3>
621
+ <ul class="option">
622
+
623
+ <li>
624
+ <span class="name">id</span>
625
+ <span class="type">(<tt>String</tt>)</span>
626
+ <span class="default">
627
+
628
+ </span>
629
+
630
+ </li>
631
+
632
+ <li>
633
+ <span class="name">maxthreads</span>
634
+ <span class="type">(<tt>Integer</tt>)</span>
635
+ <span class="default">
636
+
637
+ </span>
638
+
639
+ </li>
640
+
641
+ <li>
642
+ <span class="name">description</span>
643
+ <span class="type">(<tt>String</tt>)</span>
644
+ <span class="default">
645
+
646
+ </span>
647
+
648
+ </li>
649
+
650
+ <li>
651
+ <span class="name">nodes_pin</span>
652
+ <span class="type">(<tt>Array</tt>)</span>
653
+ <span class="default">
654
+
655
+ </span>
656
+
657
+ </li>
658
+
659
+ <li>
660
+ <span class="name">nodes_ignore</span>
661
+ <span class="type">(<tt>Array</tt>)</span>
662
+ <span class="default">
663
+
664
+ </span>
665
+
666
+ </li>
667
+
668
+ </ul>
669
+
670
+
671
+
672
+ </div><table class="source_code">
673
+ <tr>
674
+ <td>
675
+ <pre class="lines">
676
+
677
+
678
+ 48
679
+ 49
680
+ 50
681
+ 51
682
+ 52
683
+ 53
684
+ 54
685
+ 55
686
+ 56
687
+ 57
688
+ 58
689
+ 59
690
+ 60
691
+ 61
692
+ 62
693
+ 63
694
+ 64
695
+ 65
696
+ 66
697
+ 67
698
+ 68
699
+ 69
700
+ 70
701
+ 71
702
+ 72
703
+ 73
704
+ 74</pre>
705
+ </td>
706
+ <td>
707
+ <pre class="code"><span class="info file"># File 'lib/disbatch/queue.rb', line 48</span>
708
+
709
+ <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='create identifier id'>create</span><span class='lparen token'>(</span><span class='plugin identifier id'>plugin</span><span class='comma token'>,</span> <span class='opts identifier id'>opts</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
710
+
711
+ <span class='comment val'># Throw exception if plugin doesn't exist?</span>
712
+
713
+ <span class='id identifier id'>id</span> <span class='assign token'>=</span> <span class='opts identifier id'>opts</span><span class='lbrack token'>[</span><span class='symbol val'>:id</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='BSON constant id'>BSON</span><span class='colon2 op'>::</span><span class='ObjectId constant id'>ObjectId</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span>
714
+ <span class='maxthreads identifier id'>maxthreads</span> <span class='assign token'>=</span> <span class='opts identifier id'>opts</span><span class='lbrack token'>[</span><span class='symbol val'>:maxthreads</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='integer val'>10</span>
715
+ <span class='description identifier id'>description</span> <span class='assign token'>=</span> <span class='opts identifier id'>opts</span><span class='lbrack token'>[</span><span class='symbol val'>:description</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>''</span>
716
+ <span class='nodes_pin identifier id'>nodes_pin</span> <span class='assign token'>=</span> <span class='opts identifier id'>opts</span><span class='lbrack token'>[</span><span class='symbol val'>:nodes_pin</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
717
+ <span class='nodes_ignore identifier id'>nodes_ignore</span> <span class='assign token'>=</span> <span class='opts identifier id'>opts</span><span class='lbrack token'>[</span><span class='symbol val'>:nodes_ignore</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
718
+
719
+ <span class='doc identifier id'>doc</span> <span class='assign token'>=</span> <span class='Mongo constant id'>Mongo</span><span class='dot token'>.</span><span class='try identifier id'>try</span> <span class='do do kw'>do</span>
720
+ <span class='Disbatch constant id'>Disbatch</span><span class='dot token'>.</span><span class='db identifier id'>db</span><span class='lbrack token'>[</span><span class='symbol val'>:queues</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='insert identifier id'>insert</span><span class='lparen token'>(</span><span class='lbrace token'>{</span>
721
+ <span class='symbol val'>:_id</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='id identifier id'>id</span><span class='comma token'>,</span>
722
+ <span class='symbol val'>:class</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='plugin identifier id'>plugin</span><span class='comma token'>,</span>
723
+ <span class='symbol val'>:maxthreads</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='maxthreads identifier id'>maxthreads</span><span class='comma token'>,</span>
724
+ <span class='symbol val'>:description</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='description identifier id'>description</span><span class='comma token'>,</span>
725
+ <span class='symbol val'>:nodes_pin</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='nodes_pin identifier id'>nodes_pin</span><span class='comma token'>,</span>
726
+ <span class='symbol val'>:nodes_ignore</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='nodes_ignore identifier id'>nodes_ignore</span><span class='comma token'>,</span>
727
+ <span class='symbol val'>:ctime</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span>
728
+ <span class='rbrace token'>}</span><span class='rparen token'>)</span>
729
+ <span class='end end kw'>end</span>
730
+
731
+ <span class='unless unless kw'>unless</span> <span class='doc identifier id'>doc</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
732
+ <span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='plugin identifier id'>plugin</span><span class='comma token'>,</span> <span class='id identifier id'>id</span><span class='rparen token'>)</span>
733
+ <span class='end end kw'>end</span>
734
+
735
+ <span class='end end kw'>end</span>
736
+ </pre>
737
+ </td>
738
+ </tr>
739
+ </table>
740
+ </div>
741
+
742
+ <div class="method_details ">
743
+ <p class="signature " id="get-class_method">
744
+
745
+ + (<tt>Object</tt>) <strong>get</strong>(id)
746
+
747
+
748
+
749
+ </p><div class="docstring">
750
+ <div class="discussion">
751
+ <p>
752
+ Get an existing queue
753
+ </p>
754
+
755
+
756
+ </div>
757
+ </div>
758
+ <div class="tags">
759
+ <h3>Parameters:</h3>
760
+ <ul class="param">
761
+
762
+ <li>
763
+
764
+ <span class='name'>id</span>
765
+
766
+
767
+ <span class='type'>(<tt>String</tt>)</span>
768
+
769
+
770
+
771
+ </li>
772
+
773
+ </ul>
774
+
775
+
776
+ </div><table class="source_code">
777
+ <tr>
778
+ <td>
779
+ <pre class="lines">
780
+
781
+
782
+ 22
783
+ 23
784
+ 24
785
+ 25
786
+ 26
787
+ 27
788
+ 28
789
+ 29
790
+ 30</pre>
791
+ </td>
792
+ <td>
793
+ <pre class="code"><span class="info file"># File 'lib/disbatch/queue.rb', line 22</span>
794
+
795
+ <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='get identifier id'>get</span><span class='lparen token'>(</span><span class='id identifier id'>id</span><span class='rparen token'>)</span>
796
+ <span class='doc identifier id'>doc</span> <span class='assign token'>=</span> <span class='Mongo constant id'>Mongo</span><span class='dot token'>.</span><span class='try identifier id'>try</span> <span class='do do kw'>do</span>
797
+ <span class='Disbatch constant id'>Disbatch</span><span class='dot token'>.</span><span class='db identifier id'>db</span><span class='lbrack token'>[</span><span class='symbol val'>:queues</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='find_one identifier id'>find_one</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='symbol val'>:_id</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='id identifier id'>id</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
798
+ <span class='end end kw'>end</span>
799
+
800
+ <span class='unless unless kw'>unless</span> <span class='doc identifier id'>doc</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
801
+ <span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='doc identifier id'>doc</span><span class='lbrack token'>[</span><span class='string val'>'class'</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='id identifier id'>id</span><span class='rparen token'>)</span>
802
+ <span class='end end kw'>end</span>
803
+ <span class='end end kw'>end</span>
804
+ </pre>
805
+ </td>
806
+ </tr>
807
+ </table>
808
+ </div>
809
+
810
+ <div class="method_details ">
811
+ <p class="signature " id="get_all-class_method">
812
+
813
+ + (<tt>Object</tt>) <strong>get_all</strong>
814
+
815
+
816
+
817
+ </p><div class="docstring">
818
+ <div class="discussion">
819
+ <p>
820
+ Get all existing queues
821
+ </p>
822
+
823
+
824
+ </div>
825
+ </div>
826
+ <div class="tags">
827
+
828
+
829
+ </div><table class="source_code">
830
+ <tr>
831
+ <td>
832
+ <pre class="lines">
833
+
834
+
835
+ 33
836
+ 34
837
+ 35
838
+ 36
839
+ 37</pre>
840
+ </td>
841
+ <td>
842
+ <pre class="code"><span class="info file"># File 'lib/disbatch/queue.rb', line 33</span>
843
+
844
+ <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='get_all identifier id'>get_all</span>
845
+ <span class='Mongo constant id'>Mongo</span><span class='dot token'>.</span><span class='try identifier id'>try</span> <span class='do do kw'>do</span>
846
+ <span class='Disbatch constant id'>Disbatch</span><span class='dot token'>.</span><span class='db identifier id'>db</span><span class='lbrack token'>[</span><span class='symbol val'>:queues</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='find identifier id'>find</span><span class='dot token'>.</span><span class='map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='doc identifier id'>doc</span><span class='bitor op'>|</span> <span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='doc identifier id'>doc</span><span class='lbrack token'>[</span><span class='string val'>'class'</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='doc identifier id'>doc</span><span class='lbrack token'>[</span><span class='string val'>'_id'</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
847
+ <span class='end end kw'>end</span>
848
+ <span class='end end kw'>end</span>
849
+ </pre>
850
+ </td>
851
+ </tr>
852
+ </table>
853
+ </div>
854
+
855
+ </div>
856
+
857
+ <div id="instance_method_details" class="method_details_list">
858
+ <h2>Instance Method Details</h2>
859
+
860
+
861
+ <div class="method_details first">
862
+ <p class="signature first" id="==-instance_method">
863
+
864
+ - (<tt>Object</tt>) <strong>==</strong>(queue)
865
+
866
+
867
+
868
+ </p><div class="docstring">
869
+ <div class="discussion">
870
+ <p>
871
+ Check equality with another queue object
872
+ </p>
873
+ <p>
874
+ @param[Disbatch::Queue] queue another queue to compare against
875
+ </p>
876
+
877
+
878
+ </div>
879
+ </div>
880
+ <div class="tags">
881
+
882
+
883
+ </div><table class="source_code">
884
+ <tr>
885
+ <td>
886
+ <pre class="lines">
887
+
888
+
889
+ 94
890
+ 95
891
+ 96</pre>
892
+ </td>
893
+ <td>
894
+ <pre class="code"><span class="info file"># File 'lib/disbatch/queue.rb', line 94</span>
895
+
896
+ <span class='def def kw'>def</span> <span class='eq op'>==</span><span class='lparen token'>(</span><span class='queue identifier id'>queue</span><span class='rparen token'>)</span>
897
+ <span class='@id ivar id'>@id</span> <span class='eq op'>==</span> <span class='queue identifier id'>queue</span><span class='dot token'>.</span><span class='id identifier id'>id</span>
898
+ <span class='end end kw'>end</span>
899
+ </pre>
900
+ </td>
901
+ </tr>
902
+ </table>
903
+ </div>
904
+
905
+ <div class="method_details ">
906
+ <p class="signature " id="length-instance_method">
907
+
908
+ - (<tt>Object</tt>) <strong>length</strong>
909
+
910
+
911
+
912
+ <span class="aliases">Also known as:
913
+ <span class="names"><span id='size-instance_method'>size</span></span>
914
+ </span>
915
+
916
+ </p><div class="docstring">
917
+ <div class="discussion">
918
+ <p>
919
+ Number of pending tasks
920
+ </p>
921
+
922
+
923
+ </div>
924
+ </div>
925
+ <div class="tags">
926
+
927
+
928
+ </div><table class="source_code">
929
+ <tr>
930
+ <td>
931
+ <pre class="lines">
932
+
933
+
934
+ 77
935
+ 78
936
+ 79</pre>
937
+ </td>
938
+ <td>
939
+ <pre class="code"><span class="info file"># File 'lib/disbatch/queue.rb', line 77</span>
940
+
941
+ <span class='def def kw'>def</span> <span class='length identifier id'>length</span>
942
+ <span class='Disbatch constant id'>Disbatch</span><span class='dot token'>.</span><span class='db identifier id'>db</span><span class='lbrack token'>[</span><span class='symbol val'>:tasks</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='find identifier id'>find</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='symbol val'>:queue</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='@id ivar id'>@id</span><span class='comma token'>,</span> <span class='symbol val'>:status=</span><span class='gt op'>&gt;</span> <span class='integer val'>-2</span><span class='rbrace token'>}</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='count identifier id'>count</span>
943
+ <span class='end end kw'>end</span>
944
+ </pre>
945
+ </td>
946
+ </tr>
947
+ </table>
948
+ </div>
949
+
950
+ <div class="method_details ">
951
+ <p class="signature " id="pop-instance_method">
952
+
953
+ - (<tt>Object</tt>) <strong>pop</strong>
954
+
955
+
956
+
957
+ </p><div class="docstring">
958
+ <div class="discussion">
959
+ <p>
960
+ Pop a task off the queue
961
+ </p>
962
+
963
+
964
+ </div>
965
+ </div>
966
+ <div class="tags">
967
+
968
+
969
+ </div><table class="source_code">
970
+ <tr>
971
+ <td>
972
+ <pre class="lines">
973
+
974
+
975
+ 87
976
+ 88
977
+ 89</pre>
978
+ </td>
979
+ <td>
980
+ <pre class="code"><span class="info file"># File 'lib/disbatch/queue.rb', line 87</span>
981
+
982
+ <span class='def def kw'>def</span> <span class='pop identifier id'>pop</span>
983
+ <span class='Disbatch constant id'>Disbatch</span><span class='colon2 op'>::</span><span class='Queue constant id'>Queue</span><span class='colon2 op'>::</span><span class='Task constant id'>Task</span><span class='dot token'>.</span><span class='take identifier id'>take</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span>
984
+ <span class='end end kw'>end</span>
985
+ </pre>
986
+ </td>
987
+ </tr>
988
+ </table>
989
+ </div>
990
+
991
+ <div class="method_details ">
992
+ <p class="signature " id="push-instance_method">
993
+
994
+ - (<tt>Object</tt>) <strong>push</strong>(parameters)
995
+
996
+
997
+
998
+ </p><div class="docstring">
999
+ <div class="discussion">
1000
+ <p>
1001
+ Push a new task onto the queue
1002
+ </p>
1003
+
1004
+
1005
+ </div>
1006
+ </div>
1007
+ <div class="tags">
1008
+
1009
+
1010
+ </div><table class="source_code">
1011
+ <tr>
1012
+ <td>
1013
+ <pre class="lines">
1014
+
1015
+
1016
+ 82
1017
+ 83
1018
+ 84</pre>
1019
+ </td>
1020
+ <td>
1021
+ <pre class="code"><span class="info file"># File 'lib/disbatch/queue.rb', line 82</span>
1022
+
1023
+ <span class='def def kw'>def</span> <span class='push identifier id'>push</span><span class='lparen token'>(</span><span class='parameters identifier id'>parameters</span><span class='rparen token'>)</span>
1024
+ <span class='Disbatch constant id'>Disbatch</span><span class='colon2 op'>::</span><span class='Queue constant id'>Queue</span><span class='colon2 op'>::</span><span class='Task constant id'>Task</span><span class='dot token'>.</span><span class='create identifier id'>create</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='parameters identifier id'>parameters</span><span class='rparen token'>)</span>
1025
+ <span class='end end kw'>end</span>
1026
+ </pre>
1027
+ </td>
1028
+ </tr>
1029
+ </table>
1030
+ </div>
1031
+
1032
+ </div>
1033
+
1034
+ </div>
1035
+
1036
+ <div id="footer">
1037
+ Generated on Mon Oct 24 16:53:59 2011 by
1038
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1039
+ 0.7.3 (ruby-1.8.7).
1040
+ </div>
1041
+
1042
+ </body>
1043
+ </html>