disbatch 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
data/doc/Disbatch.html ADDED
@@ -0,0 +1,602 @@
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
+ Module: Disbatch
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 (D)</a> &raquo;
37
+
38
+
39
+ <span class="title">Disbatch</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>Module: Disbatch
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+
68
+
69
+ <dt class="r1">Extended by:</dt>
70
+ <dd class="r1"><span class='object_link'><a href="" title="Disbatch (module)">Disbatch</a></span></dd>
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dt class="r2">Included in:</dt>
78
+ <dd class="r2"><span class='object_link'><a href="" title="Disbatch (module)">Disbatch</a></span></dd>
79
+
80
+
81
+
82
+ <dt class="r1 last">Defined in:</dt>
83
+ <dd class="r1 last">lib/disbatch.rb<span class="defines">,<br />
84
+ lib/disbatch/errors.rb</span>
85
+ </dd>
86
+
87
+ </dl>
88
+ <div class="clear"></div>
89
+
90
+ <h2>Defined Under Namespace</h2>
91
+ <p class="children">
92
+
93
+
94
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Disbatch/Plugin.html" title="Disbatch::Plugin (module)">Plugin</a></span>
95
+
96
+
97
+
98
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Disbatch/NoNodeError.html" title="Disbatch::NoNodeError (class)">NoNodeError</a></span>, <span class='object_link'><a href="Disbatch/Node.html" title="Disbatch::Node (class)">Node</a></span>, <span class='object_link'><a href="Disbatch/Queue.html" title="Disbatch::Queue (class)">Queue</a></span>
99
+
100
+
101
+ </p>
102
+
103
+ <h2>Constant Summary</h2>
104
+
105
+ <dl class="constants">
106
+
107
+ <dt id="VERSION-constant" class="">VERSION =
108
+ <div class="docstring">
109
+ <div class="discussion">
110
+ <p>
111
+ engine version
112
+ </p>
113
+
114
+
115
+ </div>
116
+ </div>
117
+ <div class="tags">
118
+
119
+
120
+ </div>
121
+ </dt>
122
+ <dd><pre class="code"><span class='string val'>'rdisbatch 0.0.2'</span>
123
+ </pre></dd>
124
+
125
+ <dt id="SPEC_VERSION-constant" class="">SPEC_VERSION =
126
+ <div class="docstring">
127
+ <div class="discussion">
128
+ <p>
129
+ specification version
130
+ </p>
131
+
132
+
133
+ </div>
134
+ </div>
135
+ <div class="tags">
136
+
137
+
138
+ </div>
139
+ </dt>
140
+ <dd><pre class="code"><span class='string val'>'1.9'</span>
141
+ </pre></dd>
142
+
143
+ </dl>
144
+
145
+
146
+
147
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
148
+ <ul class="summary">
149
+
150
+ <li class="public ">
151
+ <span class="summary_signature">
152
+
153
+ <a href="#mongo_db-instance_method" title="#mongo_db (instance method)">- (Object) <strong>mongo_db</strong> </a>
154
+
155
+
156
+
157
+ </span>
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+ <span class="summary_desc"><div class='inline'><p>
170
+ Returns the value of attribute mongo_db.
171
+ </p>
172
+ </div></span>
173
+
174
+ </li>
175
+
176
+
177
+ <li class="public ">
178
+ <span class="summary_signature">
179
+
180
+ <a href="#mongo_hosts-instance_method" title="#mongo_hosts (instance method)">- (Object) <strong>mongo_hosts</strong> </a>
181
+
182
+
183
+
184
+ </span>
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+ <span class="summary_desc"><div class='inline'><p>
197
+ Returns the value of attribute mongo_hosts.
198
+ </p>
199
+ </div></span>
200
+
201
+ </li>
202
+
203
+
204
+ <li class="public ">
205
+ <span class="summary_signature">
206
+
207
+ <a href="#mongo_opts-instance_method" title="#mongo_opts (instance method)">- (Object) <strong>mongo_opts</strong> </a>
208
+
209
+
210
+
211
+ </span>
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+ <span class="summary_desc"><div class='inline'><p>
224
+ Returns the value of attribute mongo_opts.
225
+ </p>
226
+ </div></span>
227
+
228
+ </li>
229
+
230
+
231
+ <li class="public ">
232
+ <span class="summary_signature">
233
+
234
+ <a href="#node_id-instance_method" title="#node_id (instance method)">- (Object) <strong>node_id</strong> </a>
235
+
236
+
237
+
238
+ </span>
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+ <span class="summary_desc"><div class='inline'><p>
251
+ Returns the value of attribute node_id.
252
+ </p>
253
+ </div></span>
254
+
255
+ </li>
256
+
257
+
258
+ </ul>
259
+
260
+
261
+
262
+
263
+
264
+ <h2>
265
+ Instance Method Summary
266
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
267
+ </h2>
268
+
269
+ <ul class="summary">
270
+
271
+ <li class="public ">
272
+ <span class="summary_signature">
273
+
274
+ <a href="#db-instance_method" title="#db (instance method)">- (Object) <strong>db</strong> </a>
275
+
276
+
277
+
278
+ </span>
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+ <span class="summary_desc"><div class='inline'><p>
288
+ Return and cache the MongoDB connection pool.
289
+ </p>
290
+ </div></span>
291
+
292
+ </li>
293
+
294
+
295
+ <li class="public ">
296
+ <span class="summary_signature">
297
+
298
+ <a href="#node-instance_method" title="#node (instance method)">- (Object) <strong>node</strong> </a>
299
+
300
+
301
+
302
+ </span>
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+ <span class="summary_desc"><div class='inline'><p>
312
+ Return and cache the local node object.
313
+ </p>
314
+ </div></span>
315
+
316
+ </li>
317
+
318
+
319
+ </ul>
320
+
321
+
322
+
323
+ <div id="instance_attr_details" class="attr_details">
324
+ <h2>Instance Attribute Details</h2>
325
+
326
+
327
+ <span id="mongo_db=-instance_method"></span>
328
+ <span id="mongo_db-instance_method"></span>
329
+ <div class="method_details first">
330
+ <p class="signature first" id="mongo_db-instance_method">
331
+
332
+ - (<tt>Object</tt>) <strong>mongo_db</strong>
333
+
334
+
335
+
336
+ </p><div class="docstring">
337
+ <div class="discussion">
338
+ <p>
339
+ Returns the value of attribute mongo_db
340
+ </p>
341
+
342
+
343
+ </div>
344
+ </div>
345
+ <div class="tags">
346
+
347
+
348
+ </div><table class="source_code">
349
+ <tr>
350
+ <td>
351
+ <pre class="lines">
352
+
353
+
354
+ 9
355
+ 10
356
+ 11</pre>
357
+ </td>
358
+ <td>
359
+ <pre class="code"><span class="info file"># File 'lib/disbatch.rb', line 9</span>
360
+
361
+ <span class='def def kw'>def</span> <span class='mongo_db identifier id'>mongo_db</span>
362
+ <span class='@mongo_db ivar id'>@mongo_db</span>
363
+ <span class='end end kw'>end</span>
364
+ </pre>
365
+ </td>
366
+ </tr>
367
+ </table>
368
+ </div>
369
+
370
+
371
+ <span id="mongo_hosts=-instance_method"></span>
372
+ <span id="mongo_hosts-instance_method"></span>
373
+ <div class="method_details ">
374
+ <p class="signature " id="mongo_hosts-instance_method">
375
+
376
+ - (<tt>Object</tt>) <strong>mongo_hosts</strong>
377
+
378
+
379
+
380
+ </p><div class="docstring">
381
+ <div class="discussion">
382
+ <p>
383
+ Returns the value of attribute mongo_hosts
384
+ </p>
385
+
386
+
387
+ </div>
388
+ </div>
389
+ <div class="tags">
390
+
391
+
392
+ </div><table class="source_code">
393
+ <tr>
394
+ <td>
395
+ <pre class="lines">
396
+
397
+
398
+ 8
399
+ 9
400
+ 10</pre>
401
+ </td>
402
+ <td>
403
+ <pre class="code"><span class="info file"># File 'lib/disbatch.rb', line 8</span>
404
+
405
+ <span class='def def kw'>def</span> <span class='mongo_hosts identifier id'>mongo_hosts</span>
406
+ <span class='@mongo_hosts ivar id'>@mongo_hosts</span>
407
+ <span class='end end kw'>end</span>
408
+ </pre>
409
+ </td>
410
+ </tr>
411
+ </table>
412
+ </div>
413
+
414
+
415
+ <span id="mongo_opts=-instance_method"></span>
416
+ <span id="mongo_opts-instance_method"></span>
417
+ <div class="method_details ">
418
+ <p class="signature " id="mongo_opts-instance_method">
419
+
420
+ - (<tt>Object</tt>) <strong>mongo_opts</strong>
421
+
422
+
423
+
424
+ </p><div class="docstring">
425
+ <div class="discussion">
426
+ <p>
427
+ Returns the value of attribute mongo_opts
428
+ </p>
429
+
430
+
431
+ </div>
432
+ </div>
433
+ <div class="tags">
434
+
435
+
436
+ </div><table class="source_code">
437
+ <tr>
438
+ <td>
439
+ <pre class="lines">
440
+
441
+
442
+ 10
443
+ 11
444
+ 12</pre>
445
+ </td>
446
+ <td>
447
+ <pre class="code"><span class="info file"># File 'lib/disbatch.rb', line 10</span>
448
+
449
+ <span class='def def kw'>def</span> <span class='mongo_opts identifier id'>mongo_opts</span>
450
+ <span class='@mongo_opts ivar id'>@mongo_opts</span>
451
+ <span class='end end kw'>end</span>
452
+ </pre>
453
+ </td>
454
+ </tr>
455
+ </table>
456
+ </div>
457
+
458
+
459
+ <span id="node_id=-instance_method"></span>
460
+ <span id="node_id-instance_method"></span>
461
+ <div class="method_details ">
462
+ <p class="signature " id="node_id-instance_method">
463
+
464
+ - (<tt>Object</tt>) <strong>node_id</strong>
465
+
466
+
467
+
468
+ </p><div class="docstring">
469
+ <div class="discussion">
470
+ <p>
471
+ Returns the value of attribute node_id
472
+ </p>
473
+
474
+
475
+ </div>
476
+ </div>
477
+ <div class="tags">
478
+
479
+
480
+ </div><table class="source_code">
481
+ <tr>
482
+ <td>
483
+ <pre class="lines">
484
+
485
+
486
+ 12
487
+ 13
488
+ 14</pre>
489
+ </td>
490
+ <td>
491
+ <pre class="code"><span class="info file"># File 'lib/disbatch.rb', line 12</span>
492
+
493
+ <span class='def def kw'>def</span> <span class='node_id identifier id'>node_id</span>
494
+ <span class='@node_id ivar id'>@node_id</span>
495
+ <span class='end end kw'>end</span>
496
+ </pre>
497
+ </td>
498
+ </tr>
499
+ </table>
500
+ </div>
501
+
502
+ </div>
503
+
504
+
505
+ <div id="instance_method_details" class="method_details_list">
506
+ <h2>Instance Method Details</h2>
507
+
508
+
509
+ <div class="method_details first">
510
+ <p class="signature first" id="db-instance_method">
511
+
512
+ - (<tt>Object</tt>) <strong>db</strong>
513
+
514
+
515
+
516
+ </p><div class="docstring">
517
+ <div class="discussion">
518
+ <p>
519
+ Return and cache the MongoDB connection pool
520
+ </p>
521
+
522
+
523
+ </div>
524
+ </div>
525
+ <div class="tags">
526
+
527
+
528
+ </div><table class="source_code">
529
+ <tr>
530
+ <td>
531
+ <pre class="lines">
532
+
533
+
534
+ 29
535
+ 30
536
+ 31</pre>
537
+ </td>
538
+ <td>
539
+ <pre class="code"><span class="info file"># File 'lib/disbatch.rb', line 29</span>
540
+
541
+ <span class='def def kw'>def</span> <span class='db identifier id'>db</span>
542
+ <span class='@db ivar id'>@db</span> <span class='opasgn op'>||=</span> <span class='Mongo constant id'>Mongo</span><span class='colon2 op'>::</span><span class='ReplSetConnection constant id'>ReplSetConnection</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='lparen token'>(</span><span class='@mongo_hosts ivar id'>@mongo_hosts</span> <span class='lshft op'>&lt;&lt;</span> <span class='@mongo_opts ivar id'>@mongo_opts</span><span class='rparen token'>)</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='db identifier id'>db</span><span class='lparen token'>(</span><span class='@mongo_db ivar id'>@mongo_db</span><span class='rparen token'>)</span>
543
+ <span class='end end kw'>end</span>
544
+ </pre>
545
+ </td>
546
+ </tr>
547
+ </table>
548
+ </div>
549
+
550
+ <div class="method_details ">
551
+ <p class="signature " id="node-instance_method">
552
+
553
+ - (<tt>Object</tt>) <strong>node</strong>
554
+
555
+
556
+
557
+ </p><div class="docstring">
558
+ <div class="discussion">
559
+ <p>
560
+ Return and cache the local node object
561
+ </p>
562
+
563
+
564
+ </div>
565
+ </div>
566
+ <div class="tags">
567
+
568
+
569
+ </div><table class="source_code">
570
+ <tr>
571
+ <td>
572
+ <pre class="lines">
573
+
574
+
575
+ 34
576
+ 35
577
+ 36</pre>
578
+ </td>
579
+ <td>
580
+ <pre class="code"><span class="info file"># File 'lib/disbatch.rb', line 34</span>
581
+
582
+ <span class='def def kw'>def</span> <span class='node identifier id'>node</span>
583
+ <span class='@node ivar id'>@node</span> <span class='opasgn op'>||=</span> <span class='Disbatch constant id'>Disbatch</span><span class='colon2 op'>::</span><span class='Node constant id'>Node</span><span class='dot token'>.</span><span class='get identifier id'>get</span><span class='lparen token'>(</span><span class='@node_id ivar id'>@node_id</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='Disbatch constant id'>Disbatch</span><span class='colon2 op'>::</span><span class='Node constant id'>Node</span><span class='dot token'>.</span><span class='create identifier id'>create</span><span class='lparen token'>(</span><span class='@node_id ivar id'>@node_id</span><span class='rparen token'>)</span>
584
+ <span class='end end kw'>end</span>
585
+ </pre>
586
+ </td>
587
+ </tr>
588
+ </table>
589
+ </div>
590
+
591
+ </div>
592
+
593
+ </div>
594
+
595
+ <div id="footer">
596
+ Generated on Mon Oct 24 16:53:58 2011 by
597
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
598
+ 0.7.3 (ruby-1.8.7).
599
+ </div>
600
+
601
+ </body>
602
+ </html>