ezmq 0.1.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.
Files changed (29) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +1 -0
  3. data/Gemfile +3 -0
  4. data/LICENSE +21 -0
  5. data/README.md +25 -0
  6. data/Rakefile +34 -0
  7. data/doc/EZMQ.html +126 -0
  8. data/doc/EZMQ/Client.html +385 -0
  9. data/doc/EZMQ/Publisher.html +401 -0
  10. data/doc/EZMQ/Server.html +449 -0
  11. data/doc/EZMQ/Socket.html +1084 -0
  12. data/doc/EZMQ/Subscriber.html +693 -0
  13. data/doc/_index.html +169 -0
  14. data/doc/class_list.html +58 -0
  15. data/doc/css/common.css +1 -0
  16. data/doc/css/full_list.css +57 -0
  17. data/doc/css/style.css +339 -0
  18. data/doc/file.README.html +95 -0
  19. data/doc/file_list.html +60 -0
  20. data/doc/frames.html +26 -0
  21. data/doc/index.html +95 -0
  22. data/doc/js/app.js +219 -0
  23. data/doc/js/full_list.js +181 -0
  24. data/doc/js/jquery.js +4 -0
  25. data/doc/method_list.html +183 -0
  26. data/doc/top-level-namespace.html +112 -0
  27. data/ezmq.gemspec +27 -0
  28. data/lib/ezmq.rb +227 -0
  29. metadata +212 -0
data/doc/EZMQ/Socket.html ADDED
@@ -0,0 +1,1084 @@
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: EZMQ::Socket
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!EZMQ/Socket.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (S)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../EZMQ.html" title="EZMQ (module)">EZMQ</a></span></span>
36
+ &raquo;
37
+ <span class="title">Socket</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: EZMQ::Socket
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">EZMQ::Socket</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+ <dt class="r2 last">Defined in:</dt>
97
+ <dd class="r2 last">lib/ezmq.rb</dd>
98
+
99
+ </dl>
100
+ <div class="clear"></div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Wrapper class to simplify 0MQ sockets.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div><div id="subclasses">
114
+ <h2>Direct Known Subclasses</h2>
115
+ <p class="children"><span class='object_link'><a href="Client.html" title="EZMQ::Client (class)">Client</a></span>, <span class='object_link'><a href="Publisher.html" title="EZMQ::Publisher (class)">Publisher</a></span>, <span class='object_link'><a href="Server.html" title="EZMQ::Server (class)">Server</a></span>, <span class='object_link'><a href="Subscriber.html" title="EZMQ::Subscriber (class)">Subscriber</a></span></p>
116
+ </div>
117
+
118
+
119
+
120
+
121
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#context-instance_method" title="#context (instance method)">- (Object) <strong>context</strong> </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+ <span class="summary_desc"><div class='inline'>
145
+ <p>Returns the value of attribute context.</p>
146
+ </div></span>
147
+
148
+ </li>
149
+
150
+
151
+ <li class="public ">
152
+ <span class="summary_signature">
153
+
154
+ <a href="#decode-instance_method" title="#decode (instance method)">- (Object) <strong>decode</strong> </a>
155
+
156
+
157
+
158
+ </span>
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>Returns the value of attribute decode.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#encode-instance_method" title="#encode (instance method)">- (Object) <strong>encode</strong> </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+ <span class="summary_desc"><div class='inline'>
199
+ <p>Returns the value of attribute encode.</p>
200
+ </div></span>
201
+
202
+ </li>
203
+
204
+
205
+ <li class="public ">
206
+ <span class="summary_signature">
207
+
208
+ <a href="#socket-instance_method" title="#socket (instance method)">- (Object) <strong>socket</strong> </a>
209
+
210
+
211
+
212
+ </span>
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+ <span class="summary_desc"><div class='inline'>
226
+ <p>Returns the value of attribute socket.</p>
227
+ </div></span>
228
+
229
+ </li>
230
+
231
+
232
+ </ul>
233
+
234
+
235
+
236
+
237
+
238
+ <h2>
239
+ Instance Method Summary
240
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
241
+ </h2>
242
+
243
+ <ul class="summary">
244
+
245
+ <li class="public ">
246
+ <span class="summary_signature">
247
+
248
+ <a href="#bind-instance_method" title="#bind (instance method)">- (Boolean) <strong>bind</strong>(address: &#39;tcp://127.0.0.1:5555&#39;) </a>
249
+
250
+
251
+
252
+ </span>
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+ <span class="summary_desc"><div class='inline'>
263
+ <p>Binds the socket to the given address.</p>
264
+ </div></span>
265
+
266
+ </li>
267
+
268
+
269
+ <li class="public ">
270
+ <span class="summary_signature">
271
+
272
+ <a href="#connect-instance_method" title="#connect (instance method)">- (Boolean) <strong>connect</strong>(address: &#39;tcp://127.0.0.1:5555&#39;) </a>
273
+
274
+
275
+
276
+ </span>
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+ <span class="summary_desc"><div class='inline'>
287
+ <p>Connects the socket to the given address.</p>
288
+ </div></span>
289
+
290
+ </li>
291
+
292
+
293
+ <li class="public ">
294
+ <span class="summary_signature">
295
+
296
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Socket) <strong>initialize</strong>(mode, type, **options) </a>
297
+
298
+
299
+
300
+ </span>
301
+
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'>
313
+ <p>Creates a 0MQ socket.</p>
314
+ </div></span>
315
+
316
+ </li>
317
+
318
+
319
+ <li class="public ">
320
+ <span class="summary_signature">
321
+
322
+ <a href="#receive-instance_method" title="#receive (instance method)">- (void) <strong>receive</strong>(decode: @decode) </a>
323
+
324
+
325
+
326
+ </span>
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+ <span class="summary_desc"><div class='inline'>
337
+ <p>Receive a message from the socket.</p>
338
+ </div></span>
339
+
340
+ </li>
341
+
342
+
343
+ <li class="public ">
344
+ <span class="summary_signature">
345
+
346
+ <a href="#send-instance_method" title="#send (instance method)">- (Fixnum) <strong>send</strong>(message = &#39;&#39;, encode: @encode) </a>
347
+
348
+
349
+
350
+ </span>
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+ <span class="summary_desc"><div class='inline'>
361
+ <p>Sends a message on the socket.</p>
362
+ </div></span>
363
+
364
+ </li>
365
+
366
+
367
+ </ul>
368
+
369
+
370
+ <div id="constructor_details" class="method_details_list">
371
+ <h2>Constructor Details</h2>
372
+
373
+ <div class="method_details first">
374
+ <h3 class="signature first" id="initialize-instance_method">
375
+
376
+ - (<tt><span class='object_link'><a href="" title="EZMQ::Socket (class)">Socket</a></span></tt>) <strong>initialize</strong>(mode, type, **options)
377
+
378
+
379
+
380
+
381
+
382
+ </h3><div class="docstring">
383
+ <div class="discussion">
384
+
385
+ <p>Creates a 0MQ socket.</p>
386
+
387
+
388
+ </div>
389
+ </div>
390
+ <div class="tags">
391
+ <p class="tag_title">Parameters:</p>
392
+ <ul class="param">
393
+
394
+ <li>
395
+
396
+ <span class='name'>mode</span>
397
+
398
+
399
+ <span class='type'>(<tt>Symbol</tt>)</span>
400
+
401
+
402
+
403
+ &mdash;
404
+ <div class='inline'>
405
+ <p>the mode of the socket. `:bind` or `:connect`</p>
406
+ </div>
407
+
408
+ </li>
409
+
410
+ <li>
411
+
412
+ <span class='name'>type</span>
413
+
414
+
415
+ <span class='type'>(<tt>Object</tt>)</span>
416
+
417
+
418
+
419
+ &mdash;
420
+ <div class='inline'>
421
+ <p>the type of socket to use.</p>
422
+ </div>
423
+
424
+ </li>
425
+
426
+ <li>
427
+
428
+ <span class='name'>options</span>
429
+
430
+
431
+ <span class='type'>(<tt>Hash</tt>)</span>
432
+
433
+
434
+
435
+ &mdash;
436
+ <div class='inline'>
437
+ <p>optional parameters.</p>
438
+ </div>
439
+
440
+ </li>
441
+
442
+ </ul>
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+ <p class="tag_title">Options Hash (<tt>**options</tt>):</p>
452
+ <ul class="option">
453
+
454
+ <li>
455
+ <span class="name">context</span>
456
+ <span class="type">(<tt>ZMQ::Context</tt>)</span>
457
+ <span class="default">
458
+
459
+ </span>
460
+
461
+ &mdash; <div class='inline'>
462
+ <p>a context to use for this socket (one will be created if not provided).</p>
463
+ </div>
464
+
465
+ </li>
466
+
467
+ <li>
468
+ <span class="name">encode</span>
469
+ <span class="type">(<tt>lambda</tt>)</span>
470
+ <span class="default">
471
+
472
+ </span>
473
+
474
+ &mdash; <div class='inline'>
475
+ <p>how to encode messages. Default unaltered.</p>
476
+ </div>
477
+
478
+ </li>
479
+
480
+ <li>
481
+ <span class="name">decode</span>
482
+ <span class="type">(<tt>lambda</tt>)</span>
483
+ <span class="default">
484
+
485
+ </span>
486
+
487
+ &mdash; <div class='inline'>
488
+ <p>how to decode messages. Default unaltered.</p>
489
+ </div>
490
+
491
+ </li>
492
+
493
+ <li>
494
+ <span class="name">address</span>
495
+ <span class="type">(<tt>String</tt>)</span>
496
+ <span class="default">
497
+
498
+ </span>
499
+
500
+ &mdash; <div class='inline'>
501
+ <p>specifies protocol, address and port (if needed). Default is
502
+ &#39;tcp://127.0.0.1:5555&#39;</p>
503
+ </div>
504
+
505
+ </li>
506
+
507
+ </ul>
508
+
509
+
510
+
511
+ </div><table class="source_code">
512
+ <tr>
513
+ <td>
514
+ <pre class="lines">
515
+
516
+
517
+ 24
518
+ 25
519
+ 26
520
+ 27
521
+ 28
522
+ 29
523
+ 30
524
+ 31</pre>
525
+ </td>
526
+ <td>
527
+ <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 24</span>
528
+
529
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_mode'>mode</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
530
+ <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span> <span class='kw'>unless</span> <span class='lbracket'>[</span><span class='symbol'>:bind</span><span class='comma'>,</span> <span class='symbol'>:connect</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_mode'>mode</span>
531
+ <span class='ivar'>@context</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:context</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>ZMQ</span><span class='op'>::</span><span class='const'>Context</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
532
+ <span class='ivar'>@socket</span> <span class='op'>=</span> <span class='ivar'>@context</span><span class='period'>.</span><span class='id identifier rubyid_socket'>socket</span> <span class='id identifier rubyid_type'>type</span>
533
+ <span class='ivar'>@encode</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:encode</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tlambda'>-&gt;</span> <span class='id identifier rubyid_m'>m</span> <span class='tlambeg'>{</span> <span class='id identifier rubyid_m'>m</span> <span class='rbrace'>}</span>
534
+ <span class='ivar'>@decode</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:decode</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tlambda'>-&gt;</span> <span class='id identifier rubyid_m'>m</span> <span class='tlambeg'>{</span> <span class='id identifier rubyid_m'>m</span> <span class='rbrace'>}</span>
535
+ <span class='id identifier rubyid_method'>method</span><span class='lparen'>(</span><span class='id identifier rubyid_mode'>mode</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='label'>address:</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:address</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tcp://127.0.0.1:5555</span><span class='tstring_end'>&#39;</span></span>
536
+ <span class='kw'>end</span></pre>
537
+ </td>
538
+ </tr>
539
+ </table>
540
+ </div>
541
+
542
+ </div>
543
+
544
+ <div id="instance_attr_details" class="attr_details">
545
+ <h2>Instance Attribute Details</h2>
546
+
547
+
548
+ <span id="context=-instance_method"></span>
549
+ <div class="method_details first">
550
+ <h3 class="signature first" id="context-instance_method">
551
+
552
+ - (<tt>Object</tt>) <strong>context</strong>
553
+
554
+
555
+
556
+
557
+
558
+ </h3><div class="docstring">
559
+ <div class="discussion">
560
+
561
+ <p>Returns the value of attribute context</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
+ 7
576
+ 8
577
+ 9</pre>
578
+ </td>
579
+ <td>
580
+ <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 7</span>
581
+
582
+ <span class='kw'>def</span> <span class='id identifier rubyid_context'>context</span>
583
+ <span class='ivar'>@context</span>
584
+ <span class='kw'>end</span></pre>
585
+ </td>
586
+ </tr>
587
+ </table>
588
+ </div>
589
+
590
+
591
+ <span id="decode=-instance_method"></span>
592
+ <div class="method_details ">
593
+ <h3 class="signature " id="decode-instance_method">
594
+
595
+ - (<tt>Object</tt>) <strong>decode</strong>
596
+
597
+
598
+
599
+
600
+
601
+ </h3><div class="docstring">
602
+ <div class="discussion">
603
+
604
+ <p>Returns the value of attribute decode</p>
605
+
606
+
607
+ </div>
608
+ </div>
609
+ <div class="tags">
610
+
611
+
612
+ </div><table class="source_code">
613
+ <tr>
614
+ <td>
615
+ <pre class="lines">
616
+
617
+
618
+ 7
619
+ 8
620
+ 9</pre>
621
+ </td>
622
+ <td>
623
+ <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 7</span>
624
+
625
+ <span class='kw'>def</span> <span class='id identifier rubyid_decode'>decode</span>
626
+ <span class='ivar'>@decode</span>
627
+ <span class='kw'>end</span></pre>
628
+ </td>
629
+ </tr>
630
+ </table>
631
+ </div>
632
+
633
+
634
+ <span id="encode=-instance_method"></span>
635
+ <div class="method_details ">
636
+ <h3 class="signature " id="encode-instance_method">
637
+
638
+ - (<tt>Object</tt>) <strong>encode</strong>
639
+
640
+
641
+
642
+
643
+
644
+ </h3><div class="docstring">
645
+ <div class="discussion">
646
+
647
+ <p>Returns the value of attribute encode</p>
648
+
649
+
650
+ </div>
651
+ </div>
652
+ <div class="tags">
653
+
654
+
655
+ </div><table class="source_code">
656
+ <tr>
657
+ <td>
658
+ <pre class="lines">
659
+
660
+
661
+ 7
662
+ 8
663
+ 9</pre>
664
+ </td>
665
+ <td>
666
+ <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 7</span>
667
+
668
+ <span class='kw'>def</span> <span class='id identifier rubyid_encode'>encode</span>
669
+ <span class='ivar'>@encode</span>
670
+ <span class='kw'>end</span></pre>
671
+ </td>
672
+ </tr>
673
+ </table>
674
+ </div>
675
+
676
+
677
+ <span id="socket=-instance_method"></span>
678
+ <div class="method_details ">
679
+ <h3 class="signature " id="socket-instance_method">
680
+
681
+ - (<tt>Object</tt>) <strong>socket</strong>
682
+
683
+
684
+
685
+
686
+
687
+ </h3><div class="docstring">
688
+ <div class="discussion">
689
+
690
+ <p>Returns the value of attribute socket</p>
691
+
692
+
693
+ </div>
694
+ </div>
695
+ <div class="tags">
696
+
697
+
698
+ </div><table class="source_code">
699
+ <tr>
700
+ <td>
701
+ <pre class="lines">
702
+
703
+
704
+ 7
705
+ 8
706
+ 9</pre>
707
+ </td>
708
+ <td>
709
+ <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 7</span>
710
+
711
+ <span class='kw'>def</span> <span class='id identifier rubyid_socket'>socket</span>
712
+ <span class='ivar'>@socket</span>
713
+ <span class='kw'>end</span></pre>
714
+ </td>
715
+ </tr>
716
+ </table>
717
+ </div>
718
+
719
+ </div>
720
+
721
+
722
+ <div id="instance_method_details" class="method_details_list">
723
+ <h2>Instance Method Details</h2>
724
+
725
+
726
+ <div class="method_details first">
727
+ <h3 class="signature first" id="bind-instance_method">
728
+
729
+ - (<tt>Boolean</tt>) <strong>bind</strong>(address: &#39;tcp://127.0.0.1:5555&#39;)
730
+
731
+
732
+
733
+
734
+
735
+ </h3><div class="docstring">
736
+ <div class="discussion">
737
+
738
+ <div class="note notetag">
739
+ <strong>Note:</strong>
740
+ <div class='inline'>
741
+ <p>&#39;localhost&#39; does not always work as expected. Prefer
742
+ &#39;127.0.0.1&#39;</p>
743
+ </div>
744
+ </div>
745
+
746
+
747
+ <p>Binds the socket to the given address.</p>
748
+
749
+
750
+ </div>
751
+ </div>
752
+ <div class="tags">
753
+ <p class="tag_title">Parameters:</p>
754
+ <ul class="param">
755
+
756
+ <li>
757
+
758
+ <span class='name'>address</span>
759
+
760
+
761
+ <span class='type'>(<tt>String</tt>)</span>
762
+
763
+
764
+
765
+ &mdash;
766
+ <div class='inline'>
767
+ <p>specifies protocol, address and port (if needed). Default is
768
+ &#39;tcp://127.0.0.1:5555&#39;</p>
769
+ </div>
770
+
771
+ </li>
772
+
773
+ </ul>
774
+
775
+ <p class="tag_title">Returns:</p>
776
+ <ul class="return">
777
+
778
+ <li>
779
+
780
+
781
+ <span class='type'>(<tt>Boolean</tt>)</span>
782
+
783
+
784
+
785
+ &mdash;
786
+ <div class='inline'>
787
+ <p>was binding successful?</p>
788
+ </div>
789
+
790
+ </li>
791
+
792
+ </ul>
793
+
794
+ </div><table class="source_code">
795
+ <tr>
796
+ <td>
797
+ <pre class="lines">
798
+
799
+
800
+ 69
801
+ 70
802
+ 71</pre>
803
+ </td>
804
+ <td>
805
+ <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 69</span>
806
+
807
+ <span class='kw'>def</span> <span class='id identifier rubyid_bind'>bind</span><span class='lparen'>(</span><span class='label'>address:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tcp://127.0.0.1:5555</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
808
+ <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_bind'>bind</span><span class='lparen'>(</span><span class='id identifier rubyid_address'>address</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='int'>0</span> <span class='op'>?</span> <span class='kw'>true</span> <span class='op'>:</span> <span class='kw'>false</span>
809
+ <span class='kw'>end</span></pre>
810
+ </td>
811
+ </tr>
812
+ </table>
813
+ </div>
814
+
815
+ <div class="method_details ">
816
+ <h3 class="signature " id="connect-instance_method">
817
+
818
+ - (<tt>Boolean</tt>) <strong>connect</strong>(address: &#39;tcp://127.0.0.1:5555&#39;)
819
+
820
+
821
+
822
+
823
+
824
+ </h3><div class="docstring">
825
+ <div class="discussion">
826
+
827
+ <p>Connects the socket to the given address.</p>
828
+
829
+
830
+ </div>
831
+ </div>
832
+ <div class="tags">
833
+ <p class="tag_title">Parameters:</p>
834
+ <ul class="param">
835
+
836
+ <li>
837
+
838
+ <span class='name'>address</span>
839
+
840
+
841
+ <span class='type'>(<tt>String</tt>)</span>
842
+
843
+
844
+
845
+ &mdash;
846
+ <div class='inline'>
847
+ <p>specifies protocol, address and port (if needed). Default is
848
+ &#39;tcp://127.0.0.1:5555&#39;</p>
849
+ </div>
850
+
851
+ </li>
852
+
853
+ </ul>
854
+
855
+ <p class="tag_title">Returns:</p>
856
+ <ul class="return">
857
+
858
+ <li>
859
+
860
+
861
+ <span class='type'>(<tt>Boolean</tt>)</span>
862
+
863
+
864
+
865
+ &mdash;
866
+ <div class='inline'>
867
+ <p>was connection successful?</p>
868
+ </div>
869
+
870
+ </li>
871
+
872
+ </ul>
873
+
874
+ </div><table class="source_code">
875
+ <tr>
876
+ <td>
877
+ <pre class="lines">
878
+
879
+
880
+ 80
881
+ 81
882
+ 82</pre>
883
+ </td>
884
+ <td>
885
+ <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 80</span>
886
+
887
+ <span class='kw'>def</span> <span class='id identifier rubyid_connect'>connect</span><span class='lparen'>(</span><span class='label'>address:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tcp://127.0.0.1:5555</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
888
+ <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span><span class='lparen'>(</span><span class='id identifier rubyid_address'>address</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='int'>0</span> <span class='op'>?</span> <span class='kw'>true</span> <span class='op'>:</span> <span class='kw'>false</span>
889
+ <span class='kw'>end</span></pre>
890
+ </td>
891
+ </tr>
892
+ </table>
893
+ </div>
894
+
895
+ <div class="method_details ">
896
+ <h3 class="signature " id="receive-instance_method">
897
+
898
+ - (<tt>void</tt>) <strong>receive</strong>(decode: @decode)
899
+
900
+
901
+
902
+
903
+
904
+ </h3><div class="docstring">
905
+ <div class="discussion">
906
+
907
+ <div class="note notetag">
908
+ <strong>Note:</strong>
909
+ <div class='inline'>
910
+ <p>This method blocks until a message arrives.</p>
911
+ </div>
912
+ </div>
913
+
914
+ <p class="note returns_void">This method returns an undefined value.</p>
915
+ <p>Receive a message from the socket.</p>
916
+
917
+
918
+ </div>
919
+ </div>
920
+ <div class="tags">
921
+ <p class="tag_title">Parameters:</p>
922
+ <ul class="param">
923
+
924
+ <li>
925
+
926
+ <span class='name'>decode</span>
927
+
928
+
929
+ <span class='type'>(<tt>lambda</tt>)</span>
930
+
931
+
932
+
933
+ &mdash;
934
+ <div class='inline'>
935
+ <p>how to decode the message.</p>
936
+ </div>
937
+
938
+ </li>
939
+
940
+ </ul>
941
+
942
+
943
+ </div><table class="source_code">
944
+ <tr>
945
+ <td>
946
+ <pre class="lines">
947
+
948
+
949
+ 41
950
+ 42
951
+ 43
952
+ 44
953
+ 45</pre>
954
+ </td>
955
+ <td>
956
+ <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 41</span>
957
+
958
+ <span class='kw'>def</span> <span class='id identifier rubyid_receive'>receive</span><span class='lparen'>(</span><span class='label'>decode:</span> <span class='ivar'>@decode</span><span class='rparen'>)</span>
959
+ <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
960
+ <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_recv_string'>recv_string</span> <span class='id identifier rubyid_message'>message</span>
961
+ <span class='id identifier rubyid_decode'>decode</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='id identifier rubyid_message'>message</span>
962
+ <span class='kw'>end</span></pre>
963
+ </td>
964
+ </tr>
965
+ </table>
966
+ </div>
967
+
968
+ <div class="method_details ">
969
+ <h3 class="signature " id="send-instance_method">
970
+
971
+ - (<tt>Fixnum</tt>) <strong>send</strong>(message = &#39;&#39;, encode: @encode)
972
+
973
+
974
+
975
+
976
+
977
+ </h3><div class="docstring">
978
+ <div class="discussion">
979
+
980
+ <div class="note notetag">
981
+ <strong>Note:</strong>
982
+ <div class='inline'>
983
+ <p>If `message` is not a String, `encode` must convert it to one.</p>
984
+ </div>
985
+ </div>
986
+
987
+
988
+ <p>Sends a message on the socket.</p>
989
+
990
+
991
+ </div>
992
+ </div>
993
+ <div class="tags">
994
+ <p class="tag_title">Parameters:</p>
995
+ <ul class="param">
996
+
997
+ <li>
998
+
999
+ <span class='name'>message</span>
1000
+
1001
+
1002
+ <span class='type'>(<tt>String</tt>)</span>
1003
+
1004
+
1005
+ <em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
1006
+
1007
+
1008
+ &mdash;
1009
+ <div class='inline'>
1010
+ <p>the message to send.</p>
1011
+ </div>
1012
+
1013
+ </li>
1014
+
1015
+ <li>
1016
+
1017
+ <span class='name'>encode</span>
1018
+
1019
+
1020
+ <span class='type'>(<tt>lambda</tt>)</span>
1021
+
1022
+
1023
+
1024
+ &mdash;
1025
+ <div class='inline'>
1026
+ <p>how to encode the message.</p>
1027
+ </div>
1028
+
1029
+ </li>
1030
+
1031
+ </ul>
1032
+
1033
+ <p class="tag_title">Returns:</p>
1034
+ <ul class="return">
1035
+
1036
+ <li>
1037
+
1038
+
1039
+ <span class='type'>(<tt>Fixnum</tt>)</span>
1040
+
1041
+
1042
+
1043
+ &mdash;
1044
+ <div class='inline'>
1045
+ <p>the size of the message.</p>
1046
+ </div>
1047
+
1048
+ </li>
1049
+
1050
+ </ul>
1051
+
1052
+ </div><table class="source_code">
1053
+ <tr>
1054
+ <td>
1055
+ <pre class="lines">
1056
+
1057
+
1058
+ 56
1059
+ 57
1060
+ 58</pre>
1061
+ </td>
1062
+ <td>
1063
+ <pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 56</span>
1064
+
1065
+ <span class='kw'>def</span> <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>encode:</span> <span class='ivar'>@encode</span><span class='rparen'>)</span>
1066
+ <span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_send_string'>send_string</span> <span class='id identifier rubyid_encode'>encode</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='id identifier rubyid_message'>message</span>
1067
+ <span class='kw'>end</span></pre>
1068
+ </td>
1069
+ </tr>
1070
+ </table>
1071
+ </div>
1072
+
1073
+ </div>
1074
+
1075
+ </div>
1076
+
1077
+ <div id="footer">
1078
+ Generated on Tue Jan 6 11:26:34 2015 by
1079
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1080
+ 0.8.7.6 (ruby-2.0.0).
1081
+ </div>
1082
+
1083
+ </body>
1084
+ </html>