disbatch 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/LICENSE +27 -0
- data/README +0 -0
- data/bin/disbatchd +74 -0
- data/disbatch_specification.txt +205 -0
- data/doc/Disbatch/NoNodeError.html +128 -0
- data/doc/Disbatch/Node.html +931 -0
- data/doc/Disbatch/Plugin/Hello.html +253 -0
- data/doc/Disbatch/Plugin.html +482 -0
- data/doc/Disbatch/Plugins.html +397 -0
- data/doc/Disbatch/Queue/Task.html +1671 -0
- data/doc/Disbatch/Queue.html +1043 -0
- data/doc/Disbatch.html +602 -0
- data/doc/Mongo.html +236 -0
- data/doc/_index.html +186 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +55 -0
- data/doc/css/style.css +322 -0
- data/doc/file.README.html +66 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +66 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +167 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +446 -0
- data/doc/top-level-namespace.html +103 -0
- data/lib/disbatch/errors.rb +6 -0
- data/lib/disbatch/node.rb +105 -0
- data/lib/disbatch/plugin/hello.rb +33 -0
- data/lib/disbatch/plugin.rb +40 -0
- data/lib/disbatch/queue/task.rb +142 -0
- data/lib/disbatch/queue.rb +101 -0
- data/lib/disbatch.rb +61 -0
- metadata +147 -0
|
@@ -0,0 +1,397 @@
|
|
|
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=c" />
|
|
6
|
+
<title>
|
|
7
|
+
Module: Disbatch::Plugins
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.7.1
|
|
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 (P)</a> »
|
|
37
|
+
<span class='title'><span class='object_link'><a href="../Disbatch.html" title="Disbatch (module)">Disbatch</a></span></span>
|
|
38
|
+
»
|
|
39
|
+
<span class="title">Plugins</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::Plugins
|
|
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::Plugins (module)">Plugins</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::Plugins (module)">Plugins</a></span></dd>
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
<dt class="r1 last">Defined in:</dt>
|
|
83
|
+
<dd class="r1 last">disbatch/plugin.rb</dd>
|
|
84
|
+
|
|
85
|
+
</dl>
|
|
86
|
+
<div class="clear"></div>
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<h2>
|
|
95
|
+
Instance Method Summary
|
|
96
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
97
|
+
</h2>
|
|
98
|
+
|
|
99
|
+
<ul class="summary">
|
|
100
|
+
|
|
101
|
+
<li class="public ">
|
|
102
|
+
<span class="summary_signature">
|
|
103
|
+
|
|
104
|
+
<a href="#%5B%5D-instance_method" title="#[] (instance method)">- (Object) <strong>[]</strong>(name) </a>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</span>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
118
|
+
Return a plugin by name.
|
|
119
|
+
</p>
|
|
120
|
+
</div></span>
|
|
121
|
+
|
|
122
|
+
</li>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
<li class="public ">
|
|
126
|
+
<span class="summary_signature">
|
|
127
|
+
|
|
128
|
+
<a href="#load-instance_method" title="#load (instance method)">- (Object) <strong>load</strong>(file) </a>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
</span>
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
142
|
+
Attempt to load a plugin file.
|
|
143
|
+
</p>
|
|
144
|
+
</div></span>
|
|
145
|
+
|
|
146
|
+
</li>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<li class="public ">
|
|
150
|
+
<span class="summary_signature">
|
|
151
|
+
|
|
152
|
+
<a href="#load_all-instance_method" title="#load_all (instance method)">- (Object) <strong>load_all</strong>(path) </a>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
</span>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
166
|
+
Attempt to load all plugin files in a directory.
|
|
167
|
+
</p>
|
|
168
|
+
</div></span>
|
|
169
|
+
|
|
170
|
+
</li>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<li class="public ">
|
|
174
|
+
<span class="summary_signature">
|
|
175
|
+
|
|
176
|
+
<a href="#register-instance_method" title="#register (instance method)">- (Object) <strong>register</strong>(plugin) </a>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</span>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
190
|
+
Register a class as a plugin.
|
|
191
|
+
</p>
|
|
192
|
+
</div></span>
|
|
193
|
+
|
|
194
|
+
</li>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
</ul>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
<div id="instance_method_details" class="method_details_list">
|
|
203
|
+
<h2>Instance Method Details</h2>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<div class="method_details first">
|
|
207
|
+
<p class="signature first" id="[]-instance_method">
|
|
208
|
+
|
|
209
|
+
- (<tt>Object</tt>) <strong>[]</strong>(name)
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
</p><div class="docstring">
|
|
214
|
+
<div class="discussion">
|
|
215
|
+
<p>
|
|
216
|
+
Return a plugin by name
|
|
217
|
+
</p>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
</div>
|
|
221
|
+
</div>
|
|
222
|
+
<div class="tags">
|
|
223
|
+
|
|
224
|
+
</div><table class="source_code">
|
|
225
|
+
<tr>
|
|
226
|
+
<td>
|
|
227
|
+
<pre class="lines">
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
16
|
|
231
|
+
17
|
|
232
|
+
18</pre>
|
|
233
|
+
</td>
|
|
234
|
+
<td>
|
|
235
|
+
<pre class="code"><span class="info file"># File 'disbatch/plugin.rb', line 16</span>
|
|
236
|
+
|
|
237
|
+
<span class='def def kw'>def</span> <span class='aref op'>[]</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='rparen token'>)</span>
|
|
238
|
+
<span class='@plugins ivar id'>@plugins</span><span class='lbrack token'>[</span><span class='name identifier id'>name</span><span class='rbrack token'>]</span>
|
|
239
|
+
<span class='end end kw'>end</span>
|
|
240
|
+
</pre>
|
|
241
|
+
</td>
|
|
242
|
+
</tr>
|
|
243
|
+
</table>
|
|
244
|
+
</div>
|
|
245
|
+
|
|
246
|
+
<div class="method_details ">
|
|
247
|
+
<p class="signature " id="load-instance_method">
|
|
248
|
+
|
|
249
|
+
- (<tt>Object</tt>) <strong>load</strong>(file)
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
</p><div class="docstring">
|
|
254
|
+
<div class="discussion">
|
|
255
|
+
<p>
|
|
256
|
+
Attempt to load a plugin file
|
|
257
|
+
</p>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
</div>
|
|
261
|
+
</div>
|
|
262
|
+
<div class="tags">
|
|
263
|
+
|
|
264
|
+
</div><table class="source_code">
|
|
265
|
+
<tr>
|
|
266
|
+
<td>
|
|
267
|
+
<pre class="lines">
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
21
|
|
271
|
+
22
|
|
272
|
+
23
|
|
273
|
+
24
|
|
274
|
+
25
|
|
275
|
+
26
|
|
276
|
+
27
|
|
277
|
+
28</pre>
|
|
278
|
+
</td>
|
|
279
|
+
<td>
|
|
280
|
+
<pre class="code"><span class="info file"># File 'disbatch/plugin.rb', line 21</span>
|
|
281
|
+
|
|
282
|
+
<span class='def def kw'>def</span> <span class='load identifier id'>load</span><span class='lparen token'>(</span><span class='file identifier id'>file</span><span class='rparen token'>)</span>
|
|
283
|
+
<span class='begin begin kw'>begin</span>
|
|
284
|
+
<span class='load identifier id'>load</span> <span class='file identifier id'>file</span>
|
|
285
|
+
<span class='puts identifier id'>puts</span> <span class='dstring node'>"Loaded #{file}"</span>
|
|
286
|
+
<span class='rescue rescue kw'>rescue</span>
|
|
287
|
+
<span class='puts identifier id'>puts</span> <span class='dstring node'>"Error loading #{file}"</span>
|
|
288
|
+
<span class='end end kw'>end</span>
|
|
289
|
+
<span class='end end kw'>end</span>
|
|
290
|
+
</pre>
|
|
291
|
+
</td>
|
|
292
|
+
</tr>
|
|
293
|
+
</table>
|
|
294
|
+
</div>
|
|
295
|
+
|
|
296
|
+
<div class="method_details ">
|
|
297
|
+
<p class="signature " id="load_all-instance_method">
|
|
298
|
+
|
|
299
|
+
- (<tt>Object</tt>) <strong>load_all</strong>(path)
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</p><div class="docstring">
|
|
304
|
+
<div class="discussion">
|
|
305
|
+
<p>
|
|
306
|
+
Attempt to load all plugin files in a directory
|
|
307
|
+
</p>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</div>
|
|
311
|
+
</div>
|
|
312
|
+
<div class="tags">
|
|
313
|
+
|
|
314
|
+
</div><table class="source_code">
|
|
315
|
+
<tr>
|
|
316
|
+
<td>
|
|
317
|
+
<pre class="lines">
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
31
|
|
321
|
+
32
|
|
322
|
+
33</pre>
|
|
323
|
+
</td>
|
|
324
|
+
<td>
|
|
325
|
+
<pre class="code"><span class="info file"># File 'disbatch/plugin.rb', line 31</span>
|
|
326
|
+
|
|
327
|
+
<span class='def def kw'>def</span> <span class='load_all identifier id'>load_all</span><span class='lparen token'>(</span><span class='path identifier id'>path</span><span class='rparen token'>)</span>
|
|
328
|
+
<span class='Dir constant id'>Dir</span><span class='lparen token'>(</span><span class='path identifier id'>path</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='file identifier id'>file</span><span class='bitor op'>|</span> <span class='load identifier id'>load</span><span class='lparen token'>(</span><span class='file identifier id'>file</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
|
|
329
|
+
<span class='end end kw'>end</span>
|
|
330
|
+
</pre>
|
|
331
|
+
</td>
|
|
332
|
+
</tr>
|
|
333
|
+
</table>
|
|
334
|
+
</div>
|
|
335
|
+
|
|
336
|
+
<div class="method_details ">
|
|
337
|
+
<p class="signature " id="register-instance_method">
|
|
338
|
+
|
|
339
|
+
- (<tt>Object</tt>) <strong>register</strong>(plugin)
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
</p><div class="docstring">
|
|
344
|
+
<div class="discussion">
|
|
345
|
+
<p>
|
|
346
|
+
Register a class as a plugin
|
|
347
|
+
</p>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
</div>
|
|
351
|
+
</div>
|
|
352
|
+
<div class="tags">
|
|
353
|
+
|
|
354
|
+
</div><table class="source_code">
|
|
355
|
+
<tr>
|
|
356
|
+
<td>
|
|
357
|
+
<pre class="lines">
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
6
|
|
361
|
+
7
|
|
362
|
+
8
|
|
363
|
+
9
|
|
364
|
+
10
|
|
365
|
+
11
|
|
366
|
+
12
|
|
367
|
+
13</pre>
|
|
368
|
+
</td>
|
|
369
|
+
<td>
|
|
370
|
+
<pre class="code"><span class="info file"># File 'disbatch/plugin.rb', line 6</span>
|
|
371
|
+
|
|
372
|
+
<span class='def def kw'>def</span> <span class='register identifier id'>register</span><span class='lparen token'>(</span><span class='plugin identifier id'>plugin</span><span class='rparen token'>)</span>
|
|
373
|
+
<span class='name identifier id'>name</span> <span class='assign token'>=</span> <span class='plugin identifier id'>plugin</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span>
|
|
374
|
+
|
|
375
|
+
<span class='return return kw'>return</span> <span class='false false kw'>false</span> <span class='unless unless_mod kw'>unless</span> <span class='plugin identifier id'>plugin</span><span class='dot token'>.</span><span class='responds_to? fid id'>responds_to?</span><span class='lparen token'>(</span><span class='execute identifier id'>execute</span><span class='rparen token'>)</span>
|
|
376
|
+
|
|
377
|
+
<span class='@plugins ivar id'>@plugins</span><span class='lbrack token'>[</span><span class='name identifier id'>name</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='plugin identifier id'>plugin</span>
|
|
378
|
+
<span class='puts identifier id'>puts</span> <span class='dstring node'>"Registered #{name}"</span>
|
|
379
|
+
<span class='end end kw'>end</span>
|
|
380
|
+
</pre>
|
|
381
|
+
</td>
|
|
382
|
+
</tr>
|
|
383
|
+
</table>
|
|
384
|
+
</div>
|
|
385
|
+
|
|
386
|
+
</div>
|
|
387
|
+
|
|
388
|
+
</div>
|
|
389
|
+
|
|
390
|
+
<div id="footer">
|
|
391
|
+
Generated on Tue Jun 7 17:28:10 2011 by
|
|
392
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
393
|
+
0.7.1 (ruby-1.8.7).
|
|
394
|
+
</div>
|
|
395
|
+
|
|
396
|
+
</body>
|
|
397
|
+
</html>
|