tiny_conveyor 0.0.1

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.
@@ -0,0 +1,715 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: TinyConveyor::Parcel
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "TinyConveyor::Parcel";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (P)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../TinyConveyor.html" title="TinyConveyor (module)">TinyConveyor</a></span></span>
41
+ &raquo;
42
+ <span class="title">Parcel</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: TinyConveyor::Parcel
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">TinyConveyor::Parcel</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/tiny_conveyor/parcel.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Encapsulate an action to run in a separated thread</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+
116
+
117
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
118
+ <ul class="summary">
119
+
120
+ <li class="public ">
121
+ <span class="summary_signature">
122
+
123
+ <a href="#description-instance_method" title="#description (instance method)">#<strong>description</strong> &#x21d2; Object </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+ <span class="note title readonly">readonly</span>
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>Returns the value of attribute description.</p>
144
+ </div></span>
145
+
146
+ </li>
147
+
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; Object </a>
153
+
154
+
155
+
156
+ </span>
157
+
158
+
159
+
160
+
161
+ <span class="note title readonly">readonly</span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>Returns the value of attribute name.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#state-instance_method" title="#state (instance method)">#<strong>state</strong> &#x21d2; Object </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+ <span class="note title readonly">readonly</span>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <span class="summary_desc"><div class='inline'>
201
+ <p>Returns the value of attribute state.</p>
202
+ </div></span>
203
+
204
+ </li>
205
+
206
+
207
+ <li class="public ">
208
+ <span class="summary_signature">
209
+
210
+ <a href="#uuid-instance_method" title="#uuid (instance method)">#<strong>uuid</strong> &#x21d2; Object </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+
217
+
218
+
219
+ <span class="note title readonly">readonly</span>
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+ <span class="summary_desc"><div class='inline'>
230
+ <p>Returns the value of attribute uuid.</p>
231
+ </div></span>
232
+
233
+ </li>
234
+
235
+
236
+ </ul>
237
+
238
+
239
+
240
+
241
+
242
+ <h2>
243
+ Instance Method Summary
244
+ <small><a href="#" class="summary_toggle">collapse</a></small>
245
+ </h2>
246
+
247
+ <ul class="summary">
248
+
249
+ <li class="public ">
250
+ <span class="summary_signature">
251
+
252
+ <a href="#execute-instance_method" title="#execute (instance method)">#<strong>execute</strong> &#x21d2; Object </a>
253
+
254
+
255
+
256
+ </span>
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+ <span class="summary_desc"><div class='inline'></div></span>
267
+
268
+ </li>
269
+
270
+
271
+ <li class="public ">
272
+ <span class="summary_signature">
273
+
274
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name, description, action) &#x21d2; Parcel </a>
275
+
276
+
277
+
278
+ </span>
279
+
280
+
281
+ <span class="note title constructor">constructor</span>
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+ <span class="summary_desc"><div class='inline'>
291
+ <p>Newly created parcel.</p>
292
+ </div></span>
293
+
294
+ </li>
295
+
296
+
297
+ <li class="public ">
298
+ <span class="summary_signature">
299
+
300
+ <a href="#running%3F-instance_method" title="#running? (instance method)">#<strong>running?</strong> &#x21d2; boolean </a>
301
+
302
+
303
+
304
+ </span>
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+ <span class="summary_desc"><div class='inline'>
315
+ <p>True if the parcel is executed, false otherwhise.</p>
316
+ </div></span>
317
+
318
+ </li>
319
+
320
+
321
+ </ul>
322
+
323
+
324
+ <div id="constructor_details" class="method_details_list">
325
+ <h2>Constructor Details</h2>
326
+
327
+ <div class="method_details first">
328
+ <h3 class="signature first" id="initialize-instance_method">
329
+
330
+ #<strong>initialize</strong>(name, description, action) &#x21d2; <tt><span class='object_link'><a href="" title="TinyConveyor::Parcel (class)">Parcel</a></span></tt>
331
+
332
+
333
+
334
+
335
+
336
+ </h3><div class="docstring">
337
+ <div class="discussion">
338
+
339
+ <p>Returns newly created parcel.</p>
340
+
341
+
342
+ </div>
343
+ </div>
344
+ <div class="tags">
345
+ <p class="tag_title">Parameters:</p>
346
+ <ul class="param">
347
+
348
+ <li>
349
+
350
+ <span class='name'>name</span>
351
+
352
+
353
+ <span class='type'>(<tt>string</tt>)</span>
354
+
355
+
356
+
357
+ &mdash;
358
+ <div class='inline'>
359
+ <p>name of the task</p>
360
+ </div>
361
+
362
+ </li>
363
+
364
+ <li>
365
+
366
+ <span class='name'>description</span>
367
+
368
+
369
+ <span class='type'>(<tt>string</tt>)</span>
370
+
371
+
372
+
373
+ &mdash;
374
+ <div class='inline'>
375
+ <p>small description of the task</p>
376
+ </div>
377
+
378
+ </li>
379
+
380
+ <li>
381
+
382
+ <span class='name'>action</span>
383
+
384
+
385
+ <span class='type'>(<tt>Proc</tt>)</span>
386
+
387
+
388
+
389
+ &mdash;
390
+ <div class='inline'>
391
+ <p>action to run in separate thread</p>
392
+ </div>
393
+
394
+ </li>
395
+
396
+ </ul>
397
+
398
+
399
+ </div><table class="source_code">
400
+ <tr>
401
+ <td>
402
+ <pre class="lines">
403
+
404
+
405
+ 13
406
+ 14
407
+ 15
408
+ 16
409
+ 17
410
+ 18
411
+ 19</pre>
412
+ </td>
413
+ <td>
414
+ <pre class="code"><span class="info file"># File 'lib/tiny_conveyor/parcel.rb', line 13</span>
415
+
416
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span> <span class='id identifier rubyid_action'>action</span><span class='rparen'>)</span>
417
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
418
+ <span class='ivar'>@description</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span>
419
+ <span class='ivar'>@action</span> <span class='op'>=</span> <span class='id identifier rubyid_action'>action</span>
420
+ <span class='ivar'>@state</span> <span class='op'>=</span> <span class='symbol'>:pending</span>
421
+ <span class='ivar'>@uuid</span> <span class='op'>=</span> <span class='const'>SecureRandom</span><span class='period'>.</span><span class='id identifier rubyid_uuid'>uuid</span>
422
+ <span class='kw'>end</span></pre>
423
+ </td>
424
+ </tr>
425
+ </table>
426
+ </div>
427
+
428
+ </div>
429
+
430
+ <div id="instance_attr_details" class="attr_details">
431
+ <h2>Instance Attribute Details</h2>
432
+
433
+
434
+ <span id=""></span>
435
+ <div class="method_details first">
436
+ <h3 class="signature first" id="description-instance_method">
437
+
438
+ #<strong>description</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
439
+
440
+
441
+
442
+
443
+
444
+ </h3><div class="docstring">
445
+ <div class="discussion">
446
+
447
+ <p>Returns the value of attribute description.</p>
448
+
449
+
450
+ </div>
451
+ </div>
452
+ <div class="tags">
453
+
454
+
455
+ </div><table class="source_code">
456
+ <tr>
457
+ <td>
458
+ <pre class="lines">
459
+
460
+
461
+ 7
462
+ 8
463
+ 9</pre>
464
+ </td>
465
+ <td>
466
+ <pre class="code"><span class="info file"># File 'lib/tiny_conveyor/parcel.rb', line 7</span>
467
+
468
+ <span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
469
+ <span class='ivar'>@description</span>
470
+ <span class='kw'>end</span></pre>
471
+ </td>
472
+ </tr>
473
+ </table>
474
+ </div>
475
+
476
+
477
+ <span id=""></span>
478
+ <div class="method_details ">
479
+ <h3 class="signature " id="name-instance_method">
480
+
481
+ #<strong>name</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
482
+
483
+
484
+
485
+
486
+
487
+ </h3><div class="docstring">
488
+ <div class="discussion">
489
+
490
+ <p>Returns the value of attribute name.</p>
491
+
492
+
493
+ </div>
494
+ </div>
495
+ <div class="tags">
496
+
497
+
498
+ </div><table class="source_code">
499
+ <tr>
500
+ <td>
501
+ <pre class="lines">
502
+
503
+
504
+ 7
505
+ 8
506
+ 9</pre>
507
+ </td>
508
+ <td>
509
+ <pre class="code"><span class="info file"># File 'lib/tiny_conveyor/parcel.rb', line 7</span>
510
+
511
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
512
+ <span class='ivar'>@name</span>
513
+ <span class='kw'>end</span></pre>
514
+ </td>
515
+ </tr>
516
+ </table>
517
+ </div>
518
+
519
+
520
+ <span id=""></span>
521
+ <div class="method_details ">
522
+ <h3 class="signature " id="state-instance_method">
523
+
524
+ #<strong>state</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
525
+
526
+
527
+
528
+
529
+
530
+ </h3><div class="docstring">
531
+ <div class="discussion">
532
+
533
+ <p>Returns the value of attribute state.</p>
534
+
535
+
536
+ </div>
537
+ </div>
538
+ <div class="tags">
539
+
540
+
541
+ </div><table class="source_code">
542
+ <tr>
543
+ <td>
544
+ <pre class="lines">
545
+
546
+
547
+ 7
548
+ 8
549
+ 9</pre>
550
+ </td>
551
+ <td>
552
+ <pre class="code"><span class="info file"># File 'lib/tiny_conveyor/parcel.rb', line 7</span>
553
+
554
+ <span class='kw'>def</span> <span class='id identifier rubyid_state'>state</span>
555
+ <span class='ivar'>@state</span>
556
+ <span class='kw'>end</span></pre>
557
+ </td>
558
+ </tr>
559
+ </table>
560
+ </div>
561
+
562
+
563
+ <span id=""></span>
564
+ <div class="method_details ">
565
+ <h3 class="signature " id="uuid-instance_method">
566
+
567
+ #<strong>uuid</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
568
+
569
+
570
+
571
+
572
+
573
+ </h3><div class="docstring">
574
+ <div class="discussion">
575
+
576
+ <p>Returns the value of attribute uuid.</p>
577
+
578
+
579
+ </div>
580
+ </div>
581
+ <div class="tags">
582
+
583
+
584
+ </div><table class="source_code">
585
+ <tr>
586
+ <td>
587
+ <pre class="lines">
588
+
589
+
590
+ 7
591
+ 8
592
+ 9</pre>
593
+ </td>
594
+ <td>
595
+ <pre class="code"><span class="info file"># File 'lib/tiny_conveyor/parcel.rb', line 7</span>
596
+
597
+ <span class='kw'>def</span> <span class='id identifier rubyid_uuid'>uuid</span>
598
+ <span class='ivar'>@uuid</span>
599
+ <span class='kw'>end</span></pre>
600
+ </td>
601
+ </tr>
602
+ </table>
603
+ </div>
604
+
605
+ </div>
606
+
607
+
608
+ <div id="instance_method_details" class="method_details_list">
609
+ <h2>Instance Method Details</h2>
610
+
611
+
612
+ <div class="method_details first">
613
+ <h3 class="signature first" id="execute-instance_method">
614
+
615
+ #<strong>execute</strong> &#x21d2; <tt>Object</tt>
616
+
617
+
618
+
619
+
620
+
621
+ </h3><table class="source_code">
622
+ <tr>
623
+ <td>
624
+ <pre class="lines">
625
+
626
+
627
+ 21
628
+ 22
629
+ 23
630
+ 24</pre>
631
+ </td>
632
+ <td>
633
+ <pre class="code"><span class="info file"># File 'lib/tiny_conveyor/parcel.rb', line 21</span>
634
+
635
+ <span class='kw'>def</span> <span class='id identifier rubyid_execute'>execute</span>
636
+ <span class='ivar'>@state</span> <span class='op'>=</span> <span class='symbol'>:running</span>
637
+ <span class='ivar'>@action</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
638
+ <span class='kw'>end</span></pre>
639
+ </td>
640
+ </tr>
641
+ </table>
642
+ </div>
643
+
644
+ <div class="method_details ">
645
+ <h3 class="signature " id="running?-instance_method">
646
+
647
+ #<strong>running?</strong> &#x21d2; <tt>boolean</tt>
648
+
649
+
650
+
651
+
652
+
653
+ </h3><div class="docstring">
654
+ <div class="discussion">
655
+
656
+ <p>Returns true if the parcel is executed, false otherwhise.</p>
657
+
658
+
659
+ </div>
660
+ </div>
661
+ <div class="tags">
662
+
663
+ <p class="tag_title">Returns:</p>
664
+ <ul class="return">
665
+
666
+ <li>
667
+
668
+
669
+ <span class='type'>(<tt>boolean</tt>)</span>
670
+
671
+
672
+
673
+ &mdash;
674
+ <div class='inline'>
675
+ <p>true if the parcel is executed, false otherwhise</p>
676
+ </div>
677
+
678
+ </li>
679
+
680
+ </ul>
681
+
682
+ </div><table class="source_code">
683
+ <tr>
684
+ <td>
685
+ <pre class="lines">
686
+
687
+
688
+ 27
689
+ 28
690
+ 29</pre>
691
+ </td>
692
+ <td>
693
+ <pre class="code"><span class="info file"># File 'lib/tiny_conveyor/parcel.rb', line 27</span>
694
+
695
+ <span class='kw'>def</span> <span class='id identifier rubyid_running?'>running?</span>
696
+ <span class='ivar'>@state</span> <span class='op'>==</span> <span class='symbol'>:running</span>
697
+ <span class='kw'>end</span></pre>
698
+ </td>
699
+ </tr>
700
+ </table>
701
+ </div>
702
+
703
+ </div>
704
+
705
+ </div>
706
+
707
+ <div id="footer">
708
+ Generated on Sun Jun 6 12:46:52 2021 by
709
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
710
+ 0.9.26 (ruby-2.6.6).
711
+ </div>
712
+
713
+ </div>
714
+ </body>
715
+ </html>