ezmq 0.1.2 → 0.2.0
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.
- checksums.yaml +4 -4
- data/README.md +96 -2
- data/UPGRADING.md +12 -0
- data/doc/EZMQ.html +1 -1
- data/doc/EZMQ/Client.html +61 -32
- data/doc/EZMQ/Publisher.html +44 -18
- data/doc/EZMQ/Server.html +77 -127
- data/doc/EZMQ/Socket.html +301 -59
- data/doc/EZMQ/Subscriber.html +72 -62
- data/doc/_index.html +1 -1
- data/doc/file.README.html +89 -3
- data/doc/index.html +89 -3
- data/doc/method_list.html +16 -22
- data/doc/top-level-namespace.html +1 -1
- data/ezmq.gemspec +1 -1
- data/lib/ezmq.rb +120 -83
- metadata +3 -2
data/doc/EZMQ/Socket.html
CHANGED
@@ -245,7 +245,7 @@
|
|
245
245
|
<li class="public ">
|
246
246
|
<span class="summary_signature">
|
247
247
|
|
248
|
-
<a href="#bind-instance_method" title="#bind (instance method)">- (Boolean) <strong>bind</strong>(address: '
|
248
|
+
<a href="#bind-instance_method" title="#bind (instance method)">- (Boolean) <strong>bind</strong>(protocol: 'tcp', address: '127.0.0.1', port: 5555) </a>
|
249
249
|
|
250
250
|
|
251
251
|
|
@@ -269,7 +269,7 @@
|
|
269
269
|
<li class="public ">
|
270
270
|
<span class="summary_signature">
|
271
271
|
|
272
|
-
<a href="#connect-instance_method" title="#connect (instance method)">- (Boolean) <strong>connect</strong>(address: '
|
272
|
+
<a href="#connect-instance_method" title="#connect (instance method)">- (Boolean) <strong>connect</strong>(protocol: 'tcp', address: '127.0.0.1', port: 5555) </a>
|
273
273
|
|
274
274
|
|
275
275
|
|
@@ -319,7 +319,7 @@
|
|
319
319
|
<li class="public ">
|
320
320
|
<span class="summary_signature">
|
321
321
|
|
322
|
-
<a href="#receive-instance_method" title="#receive (instance method)">- (
|
322
|
+
<a href="#receive-instance_method" title="#receive (instance method)">- (Object) <strong>receive</strong>(**options) {|message| ... }</a>
|
323
323
|
|
324
324
|
|
325
325
|
|
@@ -343,7 +343,7 @@
|
|
343
343
|
<li class="public ">
|
344
344
|
<span class="summary_signature">
|
345
345
|
|
346
|
-
<a href="#send-instance_method" title="#send (instance method)">- (Fixnum) <strong>send</strong>(message = '',
|
346
|
+
<a href="#send-instance_method" title="#send (instance method)">- (Fixnum) <strong>send</strong>(message = '', **options) </a>
|
347
347
|
|
348
348
|
|
349
349
|
|
@@ -382,6 +382,22 @@
|
|
382
382
|
</h3><div class="docstring">
|
383
383
|
<div class="discussion">
|
384
384
|
|
385
|
+
<div class="note notetag">
|
386
|
+
<strong>Note:</strong>
|
387
|
+
<div class='inline'>
|
388
|
+
<p>'localhost' does not always work as expected. Prefer
|
389
|
+
'127.0.0.1'</p>
|
390
|
+
</div>
|
391
|
+
</div>
|
392
|
+
|
393
|
+
<div class="note notetag">
|
394
|
+
<strong>Note:</strong>
|
395
|
+
<div class='inline'>
|
396
|
+
<p>`port` is ignored unless protocol is either 'tcp' or 'udp'.</p>
|
397
|
+
</div>
|
398
|
+
</div>
|
399
|
+
|
400
|
+
|
385
401
|
<p>Creates a 0MQ socket.</p>
|
386
402
|
|
387
403
|
|
@@ -472,7 +488,7 @@
|
|
472
488
|
</span>
|
473
489
|
|
474
490
|
— <div class='inline'>
|
475
|
-
<p>how to encode messages
|
491
|
+
<p>how to encode messages.</p>
|
476
492
|
</div>
|
477
493
|
|
478
494
|
</li>
|
@@ -485,7 +501,20 @@
|
|
485
501
|
</span>
|
486
502
|
|
487
503
|
— <div class='inline'>
|
488
|
-
<p>how to decode messages
|
504
|
+
<p>how to decode messages.</p>
|
505
|
+
</div>
|
506
|
+
|
507
|
+
</li>
|
508
|
+
|
509
|
+
<li>
|
510
|
+
<span class="name">protocol</span>
|
511
|
+
<span class="type">(<tt>String</tt>)</span>
|
512
|
+
<span class="default">
|
513
|
+
|
514
|
+
</span>
|
515
|
+
|
516
|
+
— <div class='inline'>
|
517
|
+
<p>protocol to use for transport. Default: 'tcp'</p>
|
489
518
|
</div>
|
490
519
|
|
491
520
|
</li>
|
@@ -498,8 +527,20 @@
|
|
498
527
|
</span>
|
499
528
|
|
500
529
|
— <div class='inline'>
|
501
|
-
<p>
|
502
|
-
|
530
|
+
<p>address to use for endpoint. Default: '127.0.0.1'</p>
|
531
|
+
</div>
|
532
|
+
|
533
|
+
</li>
|
534
|
+
|
535
|
+
<li>
|
536
|
+
<span class="name">port</span>
|
537
|
+
<span class="type">(<tt>Fixnum</tt>)</span>
|
538
|
+
<span class="default">
|
539
|
+
|
540
|
+
</span>
|
541
|
+
|
542
|
+
— <div class='inline'>
|
543
|
+
<p>port to use for endpoint. Default: 5555</p>
|
503
544
|
</div>
|
504
545
|
|
505
546
|
</li>
|
@@ -514,17 +555,18 @@
|
|
514
555
|
<pre class="lines">
|
515
556
|
|
516
557
|
|
517
|
-
24
|
518
|
-
25
|
519
|
-
26
|
520
|
-
27
|
521
|
-
28
|
522
|
-
29
|
523
558
|
30
|
524
|
-
31
|
559
|
+
31
|
560
|
+
32
|
561
|
+
33
|
562
|
+
34
|
563
|
+
35
|
564
|
+
36
|
565
|
+
37
|
566
|
+
38</pre>
|
525
567
|
</td>
|
526
568
|
<td>
|
527
|
-
<pre class="code"><span class="info file"># File 'lib/ezmq.rb', line
|
569
|
+
<pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 30</span>
|
528
570
|
|
529
571
|
<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
572
|
<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>
|
@@ -532,7 +574,8 @@
|
|
532
574
|
<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
575
|
<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'>-></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
576
|
<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'>-></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
|
577
|
+
<span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid__'>_</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='symbol'>:protocol</span><span class='comma'>,</span> <span class='symbol'>:address</span><span class='comma'>,</span> <span class='symbol'>:port</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_k'>k</span> <span class='rbrace'>}</span>
|
578
|
+
<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='id identifier rubyid_endpoint'>endpoint</span>
|
536
579
|
<span class='kw'>end</span></pre>
|
537
580
|
</td>
|
538
581
|
</tr>
|
@@ -726,7 +769,7 @@
|
|
726
769
|
<div class="method_details first">
|
727
770
|
<h3 class="signature first" id="bind-instance_method">
|
728
771
|
|
729
|
-
- (<tt>Boolean</tt>) <strong>bind</strong>(address: '
|
772
|
+
- (<tt>Boolean</tt>) <strong>bind</strong>(protocol: 'tcp', address: '127.0.0.1', port: 5555)
|
730
773
|
|
731
774
|
|
732
775
|
|
@@ -743,6 +786,13 @@
|
|
743
786
|
</div>
|
744
787
|
</div>
|
745
788
|
|
789
|
+
<div class="note notetag">
|
790
|
+
<strong>Note:</strong>
|
791
|
+
<div class='inline'>
|
792
|
+
<p>`port` is ignored unless protocol is either 'tcp' or 'udp'.</p>
|
793
|
+
</div>
|
794
|
+
</div>
|
795
|
+
|
746
796
|
|
747
797
|
<p>Binds the socket to the given address.</p>
|
748
798
|
|
@@ -753,6 +803,22 @@
|
|
753
803
|
<p class="tag_title">Parameters:</p>
|
754
804
|
<ul class="param">
|
755
805
|
|
806
|
+
<li>
|
807
|
+
|
808
|
+
<span class='name'>protocol</span>
|
809
|
+
|
810
|
+
|
811
|
+
<span class='type'>(<tt>String</tt>)</span>
|
812
|
+
|
813
|
+
|
814
|
+
|
815
|
+
—
|
816
|
+
<div class='inline'>
|
817
|
+
<p>protocol to use for transport. Default: 'tcp'</p>
|
818
|
+
</div>
|
819
|
+
|
820
|
+
</li>
|
821
|
+
|
756
822
|
<li>
|
757
823
|
|
758
824
|
<span class='name'>address</span>
|
@@ -764,8 +830,23 @@
|
|
764
830
|
|
765
831
|
—
|
766
832
|
<div class='inline'>
|
767
|
-
<p>
|
768
|
-
|
833
|
+
<p>address to use for endpoint. Default: '127.0.0.1'</p>
|
834
|
+
</div>
|
835
|
+
|
836
|
+
</li>
|
837
|
+
|
838
|
+
<li>
|
839
|
+
|
840
|
+
<span class='name'>port</span>
|
841
|
+
|
842
|
+
|
843
|
+
<span class='type'>(<tt>Fixnum</tt>)</span>
|
844
|
+
|
845
|
+
|
846
|
+
|
847
|
+
—
|
848
|
+
<div class='inline'>
|
849
|
+
<p>port to use for endpoint. Default: 5555</p>
|
769
850
|
</div>
|
770
851
|
|
771
852
|
</li>
|
@@ -797,15 +878,19 @@
|
|
797
878
|
<pre class="lines">
|
798
879
|
|
799
880
|
|
800
|
-
|
801
|
-
|
802
|
-
|
881
|
+
88
|
882
|
+
89
|
883
|
+
90
|
884
|
+
91
|
885
|
+
92</pre>
|
803
886
|
</td>
|
804
887
|
<td>
|
805
|
-
<pre class="code"><span class="info file"># File 'lib/ezmq.rb', line
|
888
|
+
<pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 88</span>
|
806
889
|
|
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'>'</span><span class='tstring_content'>
|
808
|
-
<span class='
|
890
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_bind'>bind</span><span class='lparen'>(</span><span class='label'>protocol:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>tcp</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>address:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>127.0.0.1</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>port:</span> <span class='int'>5555</span><span class='rparen'>)</span>
|
891
|
+
<span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_protocol'>protocol</span> <span class='embexpr_end'>}</span><span class='tstring_content'>://</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_address'>address</span> <span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
892
|
+
<span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_endpoint'>endpoint</span> <span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_port'>port</span> <span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='qwords_beg'>%w(</span><span class='tstring_content'>tcp</span><span class='words_sep'> </span><span class='tstring_content'>udp</span><span class='words_sep'>)</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_protocol'>protocol</span>
|
893
|
+
<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_endpoint'>endpoint</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='int'>0</span>
|
809
894
|
<span class='kw'>end</span></pre>
|
810
895
|
</td>
|
811
896
|
</tr>
|
@@ -815,7 +900,7 @@
|
|
815
900
|
<div class="method_details ">
|
816
901
|
<h3 class="signature " id="connect-instance_method">
|
817
902
|
|
818
|
-
- (<tt>Boolean</tt>) <strong>connect</strong>(address: '
|
903
|
+
- (<tt>Boolean</tt>) <strong>connect</strong>(protocol: 'tcp', address: '127.0.0.1', port: 5555)
|
819
904
|
|
820
905
|
|
821
906
|
|
@@ -824,6 +909,14 @@
|
|
824
909
|
</h3><div class="docstring">
|
825
910
|
<div class="discussion">
|
826
911
|
|
912
|
+
<div class="note notetag">
|
913
|
+
<strong>Note:</strong>
|
914
|
+
<div class='inline'>
|
915
|
+
<p>`port` is ignored unless protocol is either 'tcp' or 'udp'.</p>
|
916
|
+
</div>
|
917
|
+
</div>
|
918
|
+
|
919
|
+
|
827
920
|
<p>Connects the socket to the given address.</p>
|
828
921
|
|
829
922
|
|
@@ -833,6 +926,22 @@
|
|
833
926
|
<p class="tag_title">Parameters:</p>
|
834
927
|
<ul class="param">
|
835
928
|
|
929
|
+
<li>
|
930
|
+
|
931
|
+
<span class='name'>protocol</span>
|
932
|
+
|
933
|
+
|
934
|
+
<span class='type'>(<tt>String</tt>)</span>
|
935
|
+
|
936
|
+
|
937
|
+
|
938
|
+
—
|
939
|
+
<div class='inline'>
|
940
|
+
<p>protocol to use for transport. Default: 'tcp'</p>
|
941
|
+
</div>
|
942
|
+
|
943
|
+
</li>
|
944
|
+
|
836
945
|
<li>
|
837
946
|
|
838
947
|
<span class='name'>address</span>
|
@@ -844,8 +953,23 @@
|
|
844
953
|
|
845
954
|
—
|
846
955
|
<div class='inline'>
|
847
|
-
<p>
|
848
|
-
|
956
|
+
<p>address to use for endpoint. Default: '127.0.0.1'</p>
|
957
|
+
</div>
|
958
|
+
|
959
|
+
</li>
|
960
|
+
|
961
|
+
<li>
|
962
|
+
|
963
|
+
<span class='name'>port</span>
|
964
|
+
|
965
|
+
|
966
|
+
<span class='type'>(<tt>Fixnum</tt>)</span>
|
967
|
+
|
968
|
+
|
969
|
+
|
970
|
+
—
|
971
|
+
<div class='inline'>
|
972
|
+
<p>port to use for endpoint. Default: 5555</p>
|
849
973
|
</div>
|
850
974
|
|
851
975
|
</li>
|
@@ -877,15 +1001,19 @@
|
|
877
1001
|
<pre class="lines">
|
878
1002
|
|
879
1003
|
|
880
|
-
|
881
|
-
|
882
|
-
|
1004
|
+
103
|
1005
|
+
104
|
1006
|
+
105
|
1007
|
+
106
|
1008
|
+
107</pre>
|
883
1009
|
</td>
|
884
1010
|
<td>
|
885
|
-
<pre class="code"><span class="info file"># File 'lib/ezmq.rb', line
|
1011
|
+
<pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 103</span>
|
886
1012
|
|
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'>'</span><span class='tstring_content'>
|
888
|
-
<span class='
|
1013
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_connect'>connect</span><span class='lparen'>(</span><span class='label'>protocol:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>tcp</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>address:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>127.0.0.1</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>port:</span> <span class='int'>5555</span><span class='rparen'>)</span>
|
1014
|
+
<span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_protocol'>protocol</span> <span class='embexpr_end'>}</span><span class='tstring_content'>://</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_address'>address</span> <span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1015
|
+
<span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_endpoint'>endpoint</span> <span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_port'>port</span> <span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='qwords_beg'>%w(</span><span class='tstring_content'>tcp</span><span class='words_sep'> </span><span class='tstring_content'>udp</span><span class='words_sep'>)</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_protocol'>protocol</span>
|
1016
|
+
<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_endpoint'>endpoint</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='int'>0</span>
|
889
1017
|
<span class='kw'>end</span></pre>
|
890
1018
|
</td>
|
891
1019
|
</tr>
|
@@ -895,7 +1023,7 @@
|
|
895
1023
|
<div class="method_details ">
|
896
1024
|
<h3 class="signature " id="receive-instance_method">
|
897
1025
|
|
898
|
-
- (<tt>
|
1026
|
+
- (<tt>Object</tt>) <strong>receive</strong>(**options) {|message| ... }
|
899
1027
|
|
900
1028
|
|
901
1029
|
|
@@ -911,7 +1039,7 @@
|
|
911
1039
|
</div>
|
912
1040
|
</div>
|
913
1041
|
|
914
|
-
|
1042
|
+
|
915
1043
|
<p>Receive a message from the socket.</p>
|
916
1044
|
|
917
1045
|
|
@@ -923,22 +1051,100 @@
|
|
923
1051
|
|
924
1052
|
<li>
|
925
1053
|
|
926
|
-
<span class='name'>
|
1054
|
+
<span class='name'>options</span>
|
927
1055
|
|
928
1056
|
|
929
|
-
<span class='type'>(<tt>
|
1057
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
930
1058
|
|
931
1059
|
|
932
1060
|
|
933
1061
|
—
|
934
1062
|
<div class='inline'>
|
935
|
-
<p>
|
1063
|
+
<p>optional parameters.</p>
|
936
1064
|
</div>
|
937
1065
|
|
938
1066
|
</li>
|
939
1067
|
|
940
1068
|
</ul>
|
941
1069
|
|
1070
|
+
|
1071
|
+
|
1072
|
+
|
1073
|
+
<p class="tag_title">Options Hash (<tt>**options</tt>):</p>
|
1074
|
+
<ul class="option">
|
1075
|
+
|
1076
|
+
<li>
|
1077
|
+
<span class="name">decode</span>
|
1078
|
+
<span class="type">(<tt>lambda</tt>)</span>
|
1079
|
+
<span class="default">
|
1080
|
+
|
1081
|
+
</span>
|
1082
|
+
|
1083
|
+
— <div class='inline'>
|
1084
|
+
<p>how to decode the message.</p>
|
1085
|
+
</div>
|
1086
|
+
|
1087
|
+
</li>
|
1088
|
+
|
1089
|
+
</ul>
|
1090
|
+
|
1091
|
+
|
1092
|
+
<p class="tag_title">Yields:</p>
|
1093
|
+
<ul class="yield">
|
1094
|
+
|
1095
|
+
<li>
|
1096
|
+
|
1097
|
+
|
1098
|
+
<span class='type'></span>
|
1099
|
+
|
1100
|
+
|
1101
|
+
|
1102
|
+
|
1103
|
+
<div class='inline'>
|
1104
|
+
<p>message passes the message received to the block.</p>
|
1105
|
+
</div>
|
1106
|
+
|
1107
|
+
</li>
|
1108
|
+
|
1109
|
+
</ul>
|
1110
|
+
<p class="tag_title">Yield Parameters:</p>
|
1111
|
+
<ul class="yieldparam">
|
1112
|
+
|
1113
|
+
<li>
|
1114
|
+
|
1115
|
+
<span class='name'>message</span>
|
1116
|
+
|
1117
|
+
|
1118
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
1119
|
+
|
1120
|
+
|
1121
|
+
|
1122
|
+
—
|
1123
|
+
<div class='inline'>
|
1124
|
+
<p>the message received (decoded).</p>
|
1125
|
+
</div>
|
1126
|
+
|
1127
|
+
</li>
|
1128
|
+
|
1129
|
+
</ul>
|
1130
|
+
<p class="tag_title">Returns:</p>
|
1131
|
+
<ul class="return">
|
1132
|
+
|
1133
|
+
<li>
|
1134
|
+
|
1135
|
+
|
1136
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
1137
|
+
|
1138
|
+
|
1139
|
+
|
1140
|
+
—
|
1141
|
+
<div class='inline'>
|
1142
|
+
<p>the message received (decoded).</p>
|
1143
|
+
</div>
|
1144
|
+
|
1145
|
+
</li>
|
1146
|
+
|
1147
|
+
</ul>
|
942
1148
|
|
943
1149
|
</div><table class="source_code">
|
944
1150
|
<tr>
|
@@ -946,19 +1152,29 @@
|
|
946
1152
|
<pre class="lines">
|
947
1153
|
|
948
1154
|
|
949
|
-
|
950
|
-
|
951
|
-
|
952
|
-
|
953
|
-
|
1155
|
+
67
|
1156
|
+
68
|
1157
|
+
69
|
1158
|
+
70
|
1159
|
+
71
|
1160
|
+
72
|
1161
|
+
73
|
1162
|
+
74
|
1163
|
+
75
|
1164
|
+
76</pre>
|
954
1165
|
</td>
|
955
1166
|
<td>
|
956
|
-
<pre class="code"><span class="info file"># File 'lib/ezmq.rb', line
|
1167
|
+
<pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 67</span>
|
957
1168
|
|
958
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_receive'>receive</span><span class='lparen'>(</span><span class='
|
1169
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_receive'>receive</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
959
1170
|
<span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
|
960
1171
|
<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
|
1172
|
+
<span class='id identifier rubyid_decoded'>decoded</span> <span class='op'>=</span> <span class='lparen'>(</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='ivar'>@decode</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='id identifier rubyid_message'>message</span>
|
1173
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
|
1174
|
+
<span class='kw'>yield</span> <span class='id identifier rubyid_decoded'>decoded</span>
|
1175
|
+
<span class='kw'>else</span>
|
1176
|
+
<span class='id identifier rubyid_decoded'>decoded</span>
|
1177
|
+
<span class='kw'>end</span>
|
962
1178
|
<span class='kw'>end</span></pre>
|
963
1179
|
</td>
|
964
1180
|
</tr>
|
@@ -968,7 +1184,7 @@
|
|
968
1184
|
<div class="method_details ">
|
969
1185
|
<h3 class="signature " id="send-instance_method">
|
970
1186
|
|
971
|
-
- (<tt>Fixnum</tt>) <strong>send</strong>(message = '',
|
1187
|
+
- (<tt>Fixnum</tt>) <strong>send</strong>(message = '', **options)
|
972
1188
|
|
973
1189
|
|
974
1190
|
|
@@ -1014,22 +1230,46 @@
|
|
1014
1230
|
|
1015
1231
|
<li>
|
1016
1232
|
|
1017
|
-
<span class='name'>
|
1233
|
+
<span class='name'>options</span>
|
1018
1234
|
|
1019
1235
|
|
1020
|
-
<span class='type'>(<tt>
|
1236
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1021
1237
|
|
1022
1238
|
|
1023
1239
|
|
1024
1240
|
—
|
1025
1241
|
<div class='inline'>
|
1026
|
-
<p>
|
1242
|
+
<p>optional parameters.</p>
|
1027
1243
|
</div>
|
1028
1244
|
|
1029
1245
|
</li>
|
1030
1246
|
|
1031
1247
|
</ul>
|
1032
1248
|
|
1249
|
+
|
1250
|
+
|
1251
|
+
|
1252
|
+
|
1253
|
+
|
1254
|
+
<p class="tag_title">Options Hash (<tt>**options</tt>):</p>
|
1255
|
+
<ul class="option">
|
1256
|
+
|
1257
|
+
<li>
|
1258
|
+
<span class="name">encode</span>
|
1259
|
+
<span class="type">(<tt>lambda</tt>)</span>
|
1260
|
+
<span class="default">
|
1261
|
+
|
1262
|
+
</span>
|
1263
|
+
|
1264
|
+
— <div class='inline'>
|
1265
|
+
<p>how to encode the message.</p>
|
1266
|
+
</div>
|
1267
|
+
|
1268
|
+
</li>
|
1269
|
+
|
1270
|
+
</ul>
|
1271
|
+
|
1272
|
+
|
1033
1273
|
<p class="tag_title">Returns:</p>
|
1034
1274
|
<ul class="return">
|
1035
1275
|
|
@@ -1055,15 +1295,17 @@
|
|
1055
1295
|
<pre class="lines">
|
1056
1296
|
|
1057
1297
|
|
1058
|
-
|
1059
|
-
|
1060
|
-
|
1298
|
+
50
|
1299
|
+
51
|
1300
|
+
52
|
1301
|
+
53</pre>
|
1061
1302
|
</td>
|
1062
1303
|
<td>
|
1063
|
-
<pre class="code"><span class="info file"># File 'lib/ezmq.rb', line
|
1304
|
+
<pre class="code"><span class="info file"># File 'lib/ezmq.rb', line 50</span>
|
1064
1305
|
|
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'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='
|
1066
|
-
<span class='
|
1306
|
+
<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'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
1307
|
+
<span class='id identifier rubyid_encoded'>encoded</span> <span class='op'>=</span> <span class='lparen'>(</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='ivar'>@encode</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='id identifier rubyid_message'>message</span>
|
1308
|
+
<span class='ivar'>@socket</span><span class='period'>.</span><span class='id identifier rubyid_send_string'>send_string</span> <span class='id identifier rubyid_encoded'>encoded</span>
|
1067
1309
|
<span class='kw'>end</span></pre>
|
1068
1310
|
</td>
|
1069
1311
|
</tr>
|
@@ -1075,7 +1317,7 @@
|
|
1075
1317
|
</div>
|
1076
1318
|
|
1077
1319
|
<div id="footer">
|
1078
|
-
Generated on
|
1320
|
+
Generated on Fri Jan 9 13:06:26 2015 by
|
1079
1321
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1080
1322
|
0.8.7.6 (ruby-2.0.0).
|
1081
1323
|
</div>
|