journeta 0.1.7 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (92) hide show
  1. data/Gemfile +8 -0
  2. data/Gemfile.lock +20 -0
  3. data/{History.txt → HISTORY} +13 -1
  4. data/LICENSE +51 -0
  5. data/License.txt +2 -2
  6. data/{README.txt → README.rdoc} +12 -17
  7. data/Rakefile +46 -112
  8. data/VERSION +1 -0
  9. data/{examples/instant_messenger.rb → bin/journeta_instant_messenger.rb} +13 -0
  10. data/bin/journeta_mock_peers.rb +32 -0
  11. data/{examples/network_status.rb → bin/journeta_network_status.rb} +0 -0
  12. data/bin/journeta_peer_fuzzer.rb +54 -0
  13. data/{examples/queue_client.rb → bin/journeta_queue_client.rb} +0 -0
  14. data/{examples/queue_server.rb → bin/journeta_queue_server.rb} +0 -0
  15. data/bin/journeta_thread_leak_check.rb +16 -0
  16. data/bin/journeta_top.rb +73 -0
  17. data/{examples/instant_messenger_gui.rb → broken/journeta_instant_messenger_gui.rb} +0 -2
  18. data/broken/journeta_instant_messenger_shoes.rb +52 -0
  19. data/lib/diff.rb +280 -0
  20. data/lib/journeta.rb +1 -0
  21. data/lib/journeta/asynchronous.rb +2 -2
  22. data/lib/journeta/exception.rb +8 -0
  23. data/lib/journeta/journeta_engine.rb +4 -5
  24. data/lib/journeta/logger.rb +1 -1
  25. data/lib/journeta/peer_connection.rb +2 -2
  26. data/lib/journeta/peer_listener.rb +2 -2
  27. data/lib/journeta/presence_broadcaster.rb +19 -5
  28. data/lib/journeta/presence_listener.rb +8 -4
  29. data/lib/journeta/version.rb +6 -4
  30. data/rdoc/Array.html +199 -0
  31. data/rdoc/Diff.html +714 -0
  32. data/rdoc/Diffable.html +409 -0
  33. data/rdoc/Journeta.html +288 -0
  34. data/rdoc/Journeta/Asynchronous.html +429 -0
  35. data/rdoc/Journeta/Common.html +205 -0
  36. data/rdoc/Journeta/Common/BasicMessage.html +228 -0
  37. data/rdoc/Journeta/Common/DummyPeerHandler.html +237 -0
  38. data/rdoc/Journeta/Common/Job.html +279 -0
  39. data/rdoc/Journeta/Common/Shutdown.html +236 -0
  40. data/rdoc/Journeta/DefaultPeerHandler.html +248 -0
  41. data/rdoc/Journeta/DefaultPeerRegisteredHandler.html +249 -0
  42. data/rdoc/Journeta/DefaultPeerUnregisteredHandler.html +249 -0
  43. data/rdoc/Journeta/DefaultPeerUpdatedHandler.html +249 -0
  44. data/rdoc/Journeta/Engine.html +953 -0
  45. data/rdoc/Journeta/Logger.html +237 -0
  46. data/rdoc/Journeta/NotImplementedException.html +188 -0
  47. data/rdoc/Journeta/PeerConnection.html +549 -0
  48. data/rdoc/Journeta/PeerListener.html +276 -0
  49. data/rdoc/Journeta/PeerRegistry.html +804 -0
  50. data/rdoc/Journeta/PresenceBroadcaster.html +306 -0
  51. data/rdoc/Journeta/PresenceListener.html +300 -0
  52. data/rdoc/Journeta/PresenceMessage.html +321 -0
  53. data/rdoc/Journeta/VERSION.html +181 -0
  54. data/rdoc/README_rdoc.html +196 -0
  55. data/rdoc/String.html +199 -0
  56. data/rdoc/created.rid +20 -0
  57. data/rdoc/index.html +212 -0
  58. data/rdoc/lib/diff_rb.html +52 -0
  59. data/rdoc/lib/journeta/asynchronous_rb.html +60 -0
  60. data/rdoc/lib/journeta/common/basic_message_rb.html +52 -0
  61. data/rdoc/lib/journeta/common/dummy_peer_handler_rb.html +52 -0
  62. data/rdoc/lib/journeta/common/job_rb.html +52 -0
  63. data/rdoc/lib/journeta/common/shutdown_rb.html +52 -0
  64. data/rdoc/lib/journeta/exception_rb.html +55 -0
  65. data/rdoc/lib/journeta/journeta_engine_rb.html +62 -0
  66. data/rdoc/lib/journeta/logger_rb.html +55 -0
  67. data/rdoc/lib/journeta/peer_connection_rb.html +58 -0
  68. data/rdoc/lib/journeta/peer_handler_rb.html +52 -0
  69. data/rdoc/lib/journeta/peer_listener_rb.html +60 -0
  70. data/rdoc/lib/journeta/peer_registry_rb.html +54 -0
  71. data/rdoc/lib/journeta/presence_broadcaster_rb.html +57 -0
  72. data/rdoc/lib/journeta/presence_listener_rb.html +62 -0
  73. data/rdoc/lib/journeta/presence_message_rb.html +52 -0
  74. data/rdoc/lib/journeta/version_rb.html +52 -0
  75. data/rdoc/lib/journeta_rb.html +91 -0
  76. data/rdoc/rdoc.css +706 -0
  77. data/test/helper.rb +19 -0
  78. data/test/test_lifecycle.rb +49 -9
  79. data/website/images/arrow.png +0 -0
  80. data/website/images/banner.jpg +0 -0
  81. data/website/images/content_shadow.png +0 -0
  82. data/website/images/content_side.png +0 -0
  83. data/website/images/header.jpg +0 -0
  84. data/website/images/header_side.jpg +0 -0
  85. data/website/index.html +1 -1
  86. data/website/index.txt +1 -1
  87. data/website/stylesheets/reset.css +30 -0
  88. data/website/stylesheets/screen.css +1 -1
  89. metadata +152 -46
  90. data/test/test_event_broadcaster.rb +0 -15
  91. data/test/test_helper.rb +0 -4
  92. data/test/test_journeta.rb +0 -11
data/rdoc/Journeta/PresenceBroadcaster.html ADDED
@@ -0,0 +1,306 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
+
8
+ <title>Class: Journeta::PresenceBroadcaster</title>
9
+
10
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
11
+
12
+ <script src="../js/jquery.js" type="text/javascript"
13
+ charset="utf-8"></script>
14
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
15
+ charset="utf-8"></script>
16
+ <script src="../js/quicksearch.js" type="text/javascript"
17
+ charset="utf-8"></script>
18
+ <script src="../js/darkfish.js" type="text/javascript"
19
+ charset="utf-8"></script>
20
+
21
+ </head>
22
+ <body class="class">
23
+
24
+ <div id="metadata">
25
+ <div id="home-metadata">
26
+ <div id="home-section" class="section">
27
+ <h3 class="section-header">
28
+ <a href="../index.html">Home</a>
29
+ <a href="../index.html#classes">Classes</a>
30
+ <a href="../index.html#methods">Methods</a>
31
+ </h3>
32
+ </div>
33
+ </div>
34
+
35
+ <div id="file-metadata">
36
+ <div id="file-list-section" class="section">
37
+ <h3 class="section-header">In Files</h3>
38
+ <div class="section-body">
39
+ <ul>
40
+
41
+ <li><a href="../lib/journeta/presence_broadcaster_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
42
+ class="thickbox" title="lib/journeta/presence_broadcaster.rb">lib/journeta/presence_broadcaster.rb</a></li>
43
+
44
+ </ul>
45
+ </div>
46
+ </div>
47
+
48
+
49
+ </div>
50
+
51
+ <div id="class-metadata">
52
+
53
+ <!-- Parent Class -->
54
+
55
+ <div id="parent-class-section" class="section">
56
+ <h3 class="section-header">Parent</h3>
57
+
58
+ <p class="link"><a href="Asynchronous.html">Journeta::Asynchronous</a></p>
59
+
60
+ </div>
61
+
62
+
63
+ <!-- Namespace Contents -->
64
+
65
+
66
+ <!-- Method Quickref -->
67
+
68
+ <div id="method-list-section" class="section">
69
+ <h3 class="section-header">Methods</h3>
70
+ <ul class="link-list">
71
+
72
+ <li><a href="#method-i-go">#go</a></li>
73
+
74
+ </ul>
75
+ </div>
76
+
77
+
78
+ <!-- Included Modules -->
79
+
80
+ </div>
81
+
82
+ <div id="project-metadata">
83
+
84
+
85
+ <div id="fileindex-section" class="section project-section">
86
+ <h3 class="section-header">Files</h3>
87
+ <ul>
88
+
89
+ <li class="file"><a href="../README_rdoc.html">README.rdoc</a></li>
90
+
91
+ </ul>
92
+ </div>
93
+
94
+
95
+ <div id="classindex-section" class="section project-section">
96
+ <h3 class="section-header">Class Index
97
+ <span class="search-toggle"><img src="../images/find.png"
98
+ height="16" width="16" alt="[+]"
99
+ title="show/hide quicksearch" /></span></h3>
100
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
101
+ <fieldset>
102
+ <legend>Quicksearch</legend>
103
+ <input type="text" name="quicksearch" value=""
104
+ class="quicksearch-field" />
105
+ </fieldset>
106
+ </form>
107
+
108
+ <ul class="link-list">
109
+
110
+ <li><a href="../Journeta/Asynchronous.html">Journeta::Asynchronous</a></li>
111
+
112
+ <li><a href="../Journeta/Common.html">Journeta::Common</a></li>
113
+
114
+ <li><a href="../Journeta/Common/BasicMessage.html">Journeta::Common::BasicMessage</a></li>
115
+
116
+ <li><a href="../Journeta/Common/DummyPeerHandler.html">Journeta::Common::DummyPeerHandler</a></li>
117
+
118
+ <li><a href="../Journeta/Common/Job.html">Journeta::Common::Job</a></li>
119
+
120
+ <li><a href="../Journeta/Common/Shutdown.html">Journeta::Common::Shutdown</a></li>
121
+
122
+ <li><a href="../Journeta/DefaultPeerHandler.html">Journeta::DefaultPeerHandler</a></li>
123
+
124
+ <li><a href="../Journeta/DefaultPeerRegisteredHandler.html">Journeta::DefaultPeerRegisteredHandler</a></li>
125
+
126
+ <li><a href="../Journeta/DefaultPeerUnregisteredHandler.html">Journeta::DefaultPeerUnregisteredHandler</a></li>
127
+
128
+ <li><a href="../Journeta/DefaultPeerUpdatedHandler.html">Journeta::DefaultPeerUpdatedHandler</a></li>
129
+
130
+ <li><a href="../Journeta/Engine.html">Journeta::Engine</a></li>
131
+
132
+ <li><a href="../Journeta/Logger.html">Journeta::Logger</a></li>
133
+
134
+ <li><a href="../Journeta/NotImplementedException.html">Journeta::NotImplementedException</a></li>
135
+
136
+ <li><a href="../Journeta/PeerConnection.html">Journeta::PeerConnection</a></li>
137
+
138
+ <li><a href="../Journeta/PeerListener.html">Journeta::PeerListener</a></li>
139
+
140
+ <li><a href="../Journeta/PeerRegistry.html">Journeta::PeerRegistry</a></li>
141
+
142
+ <li><a href="../Journeta/PresenceBroadcaster.html">Journeta::PresenceBroadcaster</a></li>
143
+
144
+ <li><a href="../Journeta/PresenceListener.html">Journeta::PresenceListener</a></li>
145
+
146
+ <li><a href="../Journeta/PresenceMessage.html">Journeta::PresenceMessage</a></li>
147
+
148
+ <li><a href="../Array.html">Array</a></li>
149
+
150
+ <li><a href="../Diff.html">Diff</a></li>
151
+
152
+ <li><a href="../Diffable.html">Diffable</a></li>
153
+
154
+ <li><a href="../String.html">String</a></li>
155
+
156
+ </ul>
157
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
158
+ </div>
159
+
160
+
161
+ </div>
162
+ </div>
163
+
164
+ <div id="documentation">
165
+ <h1 class="class">Journeta::PresenceBroadcaster</h1>
166
+
167
+ <div id="description">
168
+ <p>
169
+ Spams the local area network with metadata about the local instance. This
170
+ allows peers to make direct connections back at a later time.
171
+ </p>
172
+
173
+ </div>
174
+
175
+ <!-- Constants -->
176
+
177
+
178
+ <!-- Attributes -->
179
+
180
+ <div id="attribute-method-details" class="method-section section">
181
+ <h3 class="section-header">Attributes</h3>
182
+
183
+
184
+ <div id="thread-attribute-method" class="method-detail">
185
+ <a name="thread"></a>
186
+
187
+ <a name="thread="></a>
188
+
189
+ <div class="method-heading attribute-method-heading">
190
+ <span class="method-name">thread</span><span
191
+ class="attribute-access-type">[RW]</span>
192
+ </div>
193
+
194
+ <div class="method-description">
195
+
196
+
197
+
198
+ </div>
199
+ </div>
200
+
201
+ </div>
202
+
203
+
204
+ <!-- Methods -->
205
+
206
+ <div id="public-instance-method-details" class="method-section section">
207
+ <h3 class="section-header">Public Instance Methods</h3>
208
+
209
+
210
+ <div id="go-method" class="method-detail ">
211
+ <a name="method-i-go"></a>
212
+
213
+ <div class="method-heading">
214
+
215
+ <span class="method-name">go</span><span
216
+ class="method-args">()</span>
217
+ <span class="method-click-advice">click to toggle source</span>
218
+
219
+ </div>
220
+
221
+ <div class="method-description">
222
+
223
+
224
+
225
+
226
+
227
+ <div class="method-source-code"
228
+ id="go-source">
229
+ <pre>
230
+ <span class="ruby-comment cmt"># File lib/journeta/presence_broadcaster.rb, line 14</span>
231
+ 14: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">go</span>
232
+ 15: <span class="ruby-identifier">address</span> = <span class="ruby-ivar">@engine</span>.<span class="ruby-identifier">presence_address</span>
233
+ 16: <span class="ruby-identifier">port</span> = <span class="ruby-ivar">@engine</span>.<span class="ruby-identifier">presence_port</span>
234
+ 17: <span class="ruby-identifier">delay</span> = <span class="ruby-ivar">@engine</span>.<span class="ruby-identifier">presence_period</span>
235
+ 18: <span class="ruby-identifier">uuid</span> = <span class="ruby-ivar">@engine</span>.<span class="ruby-identifier">uuid</span>
236
+ 19: <span class="ruby-identifier">peer_port</span> = <span class="ruby-ivar">@engine</span>.<span class="ruby-identifier">peer_port</span>
237
+ 20: <span class="ruby-identifier">groups</span> = <span class="ruby-ivar">@engine</span>.<span class="ruby-identifier">groups</span>
238
+ 21: <span class="ruby-keyword kw">begin</span>
239
+ 22: <span class="ruby-identifier">socket</span> = <span class="ruby-constant">UDPSocket</span>.<span class="ruby-identifier">open</span>
240
+ 23: <span class="ruby-keyword kw">begin</span>
241
+ 24: <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">defined?</span>(<span class="ruby-constant">PLATFORM</span>) <span class="ruby-comment cmt"># v1.8 (and prior?) MRI and JRuby on Linux, Windows, OSX and Solaris.</span>
242
+ 25: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">PLATFORM</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/linux/</span>)
243
+ 26: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">setsockopt</span>( <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SOL_SOCKET</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SO_REUSEADDR</span>, [<span class="ruby-value">1</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-value str">&quot;i_&quot;</span>) )
244
+ 27: <span class="ruby-keyword kw">elsif</span> <span class="ruby-constant">PLATFORM</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/java/</span>)
245
+ 28: <span class="ruby-comment cmt"># puts 'Running on a JVM!'</span>
246
+ 29: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">setsockopt</span>( <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SOL_SOCKET</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SO_REUSEADDR</span>, [<span class="ruby-value">1</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-value str">&quot;i_&quot;</span>) )
247
+ 30: <span class="ruby-comment cmt"># socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_TTL, [1].pack('i'))</span>
248
+ 31: <span class="ruby-comment cmt"># socket.setsockopt( Socket::SOL_SOCKET, Socket::SO_REUSEPORT, [1].pack(&quot;i_&quot;) )</span>
249
+ 32: <span class="ruby-keyword kw">else</span>
250
+ 33: <span class="ruby-comment cmt"># socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_TTL, [1].pack('i')) # Preston's original config for OS X.</span>
251
+ 34: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">setsockopt</span>( <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SOL_SOCKET</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SO_REUSEPORT</span>, [<span class="ruby-value">1</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-value str">&quot;i_&quot;</span>) ) <span class="ruby-comment cmt"># Remi's suggested default.</span>
252
+ 35: <span class="ruby-keyword kw">end</span>
253
+ 36: <span class="ruby-keyword kw">elsif</span> <span class="ruby-keyword kw">defined?</span>(<span class="ruby-constant">RUBY_PLATFORM</span>) <span class="ruby-comment cmt"># Ruby 1.9 MRI</span>
254
+ 37: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">RUBY_PLATFORM</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/linux/</span>)
255
+ 38: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">setsockopt</span>( <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SOL_SOCKET</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SO_REUSEADDR</span>, [<span class="ruby-value">1</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-value str">&quot;i_&quot;</span>) )
256
+ 39: <span class="ruby-keyword kw">else</span>
257
+ 40: <span class="ruby-comment cmt"># socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_TTL, [1].pack('i'))</span>
258
+ 41: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">setsockopt</span>( <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SOL_SOCKET</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SO_REUSEPORT</span>, [<span class="ruby-value">1</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-value str">&quot;i_&quot;</span>) ) <span class="ruby-comment cmt"># Remi's suggested default.</span>
259
+ 42: <span class="ruby-keyword kw">end</span>
260
+ 43: <span class="ruby-keyword kw">end</span>
261
+ 44: <span class="ruby-keyword kw">rescue</span>
262
+ 45: <span class="ruby-identifier">puts</span> <span class="ruby-value str">&quot;Native socket library not supported on this platform. Please submit a patch! Exiting since this is fatal :(&quot;</span>
263
+ 46: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
264
+ 47: <span class="ruby-keyword kw">end</span>
265
+ 48: <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
266
+ 49: <span class="ruby-identifier">putsd</span> <span class="ruby-value str">&quot;Sending presence event.&quot;</span>
267
+ 50: <span class="ruby-identifier">note</span> = <span class="ruby-constant">PresenceMessage</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">uuid</span>, <span class="ruby-identifier">peer_port</span>, <span class="ruby-identifier">groups</span>
268
+ 51: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">note</span>.<span class="ruby-identifier">to_yaml</span>, <span class="ruby-value">0</span>, <span class="ruby-identifier">address</span>, <span class="ruby-identifier">port</span>)
269
+ 52: <span class="ruby-identifier">sleep</span> <span class="ruby-identifier">delay</span>
270
+ 53: <span class="ruby-keyword kw">end</span>
271
+ 54: <span class="ruby-keyword kw">ensure</span>
272
+ 55: <span class="ruby-identifier">putsd</span> <span class="ruby-value str">&quot;Closing event broadcaster socket.&quot;</span>
273
+ 56: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">close</span>
274
+ 57: <span class="ruby-keyword kw">end</span>
275
+ 58: <span class="ruby-keyword kw">end</span></pre>
276
+ </div>
277
+
278
+ </div>
279
+
280
+
281
+
282
+
283
+ </div>
284
+
285
+
286
+ </div>
287
+
288
+
289
+ </div>
290
+
291
+
292
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
293
+
294
+ <p>Disabled; run with --debug to generate this.</p>
295
+
296
+ </div>
297
+
298
+ <div id="validator-badges">
299
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
300
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
301
+ Rdoc Generator</a> 1.1.6</small>.</p>
302
+ </div>
303
+
304
+ </body>
305
+ </html>
306
+
data/rdoc/Journeta/PresenceListener.html ADDED
@@ -0,0 +1,300 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
+
8
+ <title>Class: Journeta::PresenceListener</title>
9
+
10
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
11
+
12
+ <script src="../js/jquery.js" type="text/javascript"
13
+ charset="utf-8"></script>
14
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
15
+ charset="utf-8"></script>
16
+ <script src="../js/quicksearch.js" type="text/javascript"
17
+ charset="utf-8"></script>
18
+ <script src="../js/darkfish.js" type="text/javascript"
19
+ charset="utf-8"></script>
20
+
21
+ </head>
22
+ <body class="class">
23
+
24
+ <div id="metadata">
25
+ <div id="home-metadata">
26
+ <div id="home-section" class="section">
27
+ <h3 class="section-header">
28
+ <a href="../index.html">Home</a>
29
+ <a href="../index.html#classes">Classes</a>
30
+ <a href="../index.html#methods">Methods</a>
31
+ </h3>
32
+ </div>
33
+ </div>
34
+
35
+ <div id="file-metadata">
36
+ <div id="file-list-section" class="section">
37
+ <h3 class="section-header">In Files</h3>
38
+ <div class="section-body">
39
+ <ul>
40
+
41
+ <li><a href="../lib/journeta/presence_listener_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
42
+ class="thickbox" title="lib/journeta/presence_listener.rb">lib/journeta/presence_listener.rb</a></li>
43
+
44
+ </ul>
45
+ </div>
46
+ </div>
47
+
48
+
49
+ </div>
50
+
51
+ <div id="class-metadata">
52
+
53
+ <!-- Parent Class -->
54
+
55
+ <div id="parent-class-section" class="section">
56
+ <h3 class="section-header">Parent</h3>
57
+
58
+ <p class="link"><a href="Asynchronous.html">Journeta::Asynchronous</a></p>
59
+
60
+ </div>
61
+
62
+
63
+ <!-- Namespace Contents -->
64
+
65
+
66
+ <!-- Method Quickref -->
67
+
68
+ <div id="method-list-section" class="section">
69
+ <h3 class="section-header">Methods</h3>
70
+ <ul class="link-list">
71
+
72
+ <li><a href="#method-i-go">#go</a></li>
73
+
74
+ </ul>
75
+ </div>
76
+
77
+
78
+ <!-- Included Modules -->
79
+
80
+ </div>
81
+
82
+ <div id="project-metadata">
83
+
84
+
85
+ <div id="fileindex-section" class="section project-section">
86
+ <h3 class="section-header">Files</h3>
87
+ <ul>
88
+
89
+ <li class="file"><a href="../README_rdoc.html">README.rdoc</a></li>
90
+
91
+ </ul>
92
+ </div>
93
+
94
+
95
+ <div id="classindex-section" class="section project-section">
96
+ <h3 class="section-header">Class Index
97
+ <span class="search-toggle"><img src="../images/find.png"
98
+ height="16" width="16" alt="[+]"
99
+ title="show/hide quicksearch" /></span></h3>
100
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
101
+ <fieldset>
102
+ <legend>Quicksearch</legend>
103
+ <input type="text" name="quicksearch" value=""
104
+ class="quicksearch-field" />
105
+ </fieldset>
106
+ </form>
107
+
108
+ <ul class="link-list">
109
+
110
+ <li><a href="../Journeta/Asynchronous.html">Journeta::Asynchronous</a></li>
111
+
112
+ <li><a href="../Journeta/Common.html">Journeta::Common</a></li>
113
+
114
+ <li><a href="../Journeta/Common/BasicMessage.html">Journeta::Common::BasicMessage</a></li>
115
+
116
+ <li><a href="../Journeta/Common/DummyPeerHandler.html">Journeta::Common::DummyPeerHandler</a></li>
117
+
118
+ <li><a href="../Journeta/Common/Job.html">Journeta::Common::Job</a></li>
119
+
120
+ <li><a href="../Journeta/Common/Shutdown.html">Journeta::Common::Shutdown</a></li>
121
+
122
+ <li><a href="../Journeta/DefaultPeerHandler.html">Journeta::DefaultPeerHandler</a></li>
123
+
124
+ <li><a href="../Journeta/DefaultPeerRegisteredHandler.html">Journeta::DefaultPeerRegisteredHandler</a></li>
125
+
126
+ <li><a href="../Journeta/DefaultPeerUnregisteredHandler.html">Journeta::DefaultPeerUnregisteredHandler</a></li>
127
+
128
+ <li><a href="../Journeta/DefaultPeerUpdatedHandler.html">Journeta::DefaultPeerUpdatedHandler</a></li>
129
+
130
+ <li><a href="../Journeta/Engine.html">Journeta::Engine</a></li>
131
+
132
+ <li><a href="../Journeta/Logger.html">Journeta::Logger</a></li>
133
+
134
+ <li><a href="../Journeta/NotImplementedException.html">Journeta::NotImplementedException</a></li>
135
+
136
+ <li><a href="../Journeta/PeerConnection.html">Journeta::PeerConnection</a></li>
137
+
138
+ <li><a href="../Journeta/PeerListener.html">Journeta::PeerListener</a></li>
139
+
140
+ <li><a href="../Journeta/PeerRegistry.html">Journeta::PeerRegistry</a></li>
141
+
142
+ <li><a href="../Journeta/PresenceBroadcaster.html">Journeta::PresenceBroadcaster</a></li>
143
+
144
+ <li><a href="../Journeta/PresenceListener.html">Journeta::PresenceListener</a></li>
145
+
146
+ <li><a href="../Journeta/PresenceMessage.html">Journeta::PresenceMessage</a></li>
147
+
148
+ <li><a href="../Array.html">Array</a></li>
149
+
150
+ <li><a href="../Diff.html">Diff</a></li>
151
+
152
+ <li><a href="../Diffable.html">Diffable</a></li>
153
+
154
+ <li><a href="../String.html">String</a></li>
155
+
156
+ </ul>
157
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
158
+ </div>
159
+
160
+
161
+ </div>
162
+ </div>
163
+
164
+ <div id="documentation">
165
+ <h1 class="class">Journeta::PresenceListener</h1>
166
+
167
+ <div id="description">
168
+ <p>
169
+ Uses the fucked up Ruby socket API (which isn&#8217;t really an API) to
170
+ listen for presence broadcast from peers. Processing of the inbound data is
171
+ quickly delegated to a background thread to allow the listener to continue
172
+ responding to inbound traffic as fast as possible.
173
+ </p>
174
+
175
+ </div>
176
+
177
+ <!-- Constants -->
178
+
179
+
180
+ <!-- Attributes -->
181
+
182
+
183
+ <!-- Methods -->
184
+
185
+ <div id="public-instance-method-details" class="method-section section">
186
+ <h3 class="section-header">Public Instance Methods</h3>
187
+
188
+
189
+ <div id="go-method" class="method-detail ">
190
+ <a name="method-i-go"></a>
191
+
192
+ <div class="method-heading">
193
+
194
+ <span class="method-name">go</span><span
195
+ class="method-args">()</span>
196
+ <span class="method-click-advice">click to toggle source</span>
197
+
198
+ </div>
199
+
200
+ <div class="method-description">
201
+
202
+
203
+
204
+
205
+
206
+ <div class="method-source-code"
207
+ id="go-source">
208
+ <pre>
209
+ <span class="ruby-comment cmt"># File lib/journeta/presence_listener.rb, line 15</span>
210
+ 15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">go</span>
211
+ 16: <span class="ruby-identifier">presence_address</span> = <span class="ruby-ivar">@engine</span>.<span class="ruby-identifier">presence_address</span>
212
+ 17: <span class="ruby-identifier">port</span> = <span class="ruby-ivar">@engine</span>.<span class="ruby-identifier">presence_port</span>
213
+ 18: <span class="ruby-identifier">addresses</span> = <span class="ruby-constant">IPAddr</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">presence_address</span>).<span class="ruby-identifier">hton</span> <span class="ruby-operator">+</span> <span class="ruby-constant">IPAddr</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">&quot;0.0.0.0&quot;</span>).<span class="ruby-identifier">hton</span>
214
+ 19: <span class="ruby-keyword kw">begin</span>
215
+ 20: <span class="ruby-identifier">socket</span> = <span class="ruby-constant">UDPSocket</span>.<span class="ruby-identifier">new</span>
216
+ 21: <span class="ruby-comment cmt"># Remember how i said this was fucked up? yeaahhhhhh. i hope you like C.</span>
217
+ 22: <span class="ruby-comment cmt"># `man setsockopt` for details.</span>
218
+ 23: <span class="ruby-comment cmt">#</span>
219
+ 24: <span class="ruby-comment cmt"># The PLATFORM constant got changed to RUBY_PLATFORM in the 1.9 MRI, so we have to handle both cases. :(</span>
220
+ 25: <span class="ruby-comment cmt"># Also note that jruby 1.3.1 uses PLATFORM.</span>
221
+ 26: <span class="ruby-keyword kw">if</span> (<span class="ruby-keyword kw">defined?</span>(<span class="ruby-constant">PLATFORM</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">PLATFORM</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/linux/</span>)) <span class="ruby-operator">||</span> (<span class="ruby-keyword kw">defined?</span>(<span class="ruby-constant">RUBY_PLATFORM</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RUBY_PLATFORM</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/linux/</span>))
222
+ 27: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">setsockopt</span>( <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SOL_SOCKET</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SO_REUSEADDR</span>, [<span class="ruby-value">1</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-value str">&quot;i_&quot;</span>) )
223
+ 28: <span class="ruby-keyword kw">elsif</span> (<span class="ruby-keyword kw">defined?</span>(<span class="ruby-constant">PLATFORM</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">PLATFORM</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/java/</span>)) <span class="ruby-operator">||</span> (<span class="ruby-keyword kw">defined?</span>(<span class="ruby-constant">RUBY_PLATFORM</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RUBY_PLATFORM</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/java/</span>))
224
+ 29: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">setsockopt</span>( <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SOL_SOCKET</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SO_REUSEADDR</span>, [<span class="ruby-value">1</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-value str">&quot;i_&quot;</span>) ) <span class="ruby-comment cmt"># TODO test this jruby case!</span>
225
+ 30: <span class="ruby-keyword kw">else</span>
226
+ 31: <span class="ruby-comment cmt"># SO_REUSEPORT is needed so multiple peers can be run on the same machine.</span>
227
+ 32: <span class="ruby-comment cmt"># socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_TTL, [1].pack('i')) # Preston's original config for OS X.</span>
228
+ 33: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">setsockopt</span>( <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SOL_SOCKET</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SO_REUSEPORT</span>, [<span class="ruby-value">1</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-value str">&quot;i_&quot;</span>) ) <span class="ruby-comment cmt"># Remi's suggested default.</span>
229
+ 34: <span class="ruby-keyword kw">end</span>
230
+ 35: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">setsockopt</span>(<span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">IPPROTO_IP</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">IP_ADD_MEMBERSHIP</span>, <span class="ruby-identifier">addresses</span>)
231
+ 36: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">bind</span>(<span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">INADDR_ANY</span>, <span class="ruby-identifier">port</span>)
232
+ 37: <span class="ruby-identifier">putsd</span> <span class="ruby-value str">&quot;Waiting for presence events.&quot;</span>
233
+ 38: <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
234
+ 39: <span class="ruby-comment cmt"># Why 1024? umm.. because it's Thursday!</span>
235
+ 40: <span class="ruby-identifier">data</span>, <span class="ruby-identifier">meta</span> = <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">recvfrom</span> <span class="ruby-value">1024</span>
236
+ 41: <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">meta</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">data</span>, <span class="ruby-identifier">meta</span><span class="ruby-operator">|</span>
237
+ 42: <span class="ruby-identifier">event</span> = <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">data</span>)
238
+ 43: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">event</span>.<span class="ruby-identifier">uuid</span> <span class="ruby-operator">!=</span> <span class="ruby-ivar">@engine</span>.<span class="ruby-identifier">uuid</span>
239
+ 44: <span class="ruby-keyword kw">begin</span>
240
+ 45: <span class="ruby-identifier">m</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load</span>(<span class="ruby-identifier">data</span>)
241
+ 46: <span class="ruby-identifier">peer</span> = <span class="ruby-constant">PeerConnection</span>.<span class="ruby-identifier">new</span> <span class="ruby-ivar">@engine</span>
242
+ 47: <span class="ruby-comment cmt"># Why is this always [2]? Not sure.. they should have returned a hash instead.</span>
243
+ 48: <span class="ruby-identifier">peer</span>.<span class="ruby-identifier">ip_address</span> = <span class="ruby-identifier">meta</span>[<span class="ruby-value">2</span>]
244
+ 49: <span class="ruby-identifier">peer</span>.<span class="ruby-identifier">peer_port</span> = <span class="ruby-identifier">m</span>.<span class="ruby-identifier">peer_port</span>
245
+ 50: <span class="ruby-identifier">peer</span>.<span class="ruby-identifier">uuid</span> = <span class="ruby-identifier">m</span>.<span class="ruby-identifier">uuid</span>
246
+ 51: <span class="ruby-identifier">peer</span>.<span class="ruby-identifier">version</span> = <span class="ruby-identifier">m</span>.<span class="ruby-identifier">version</span>
247
+ 52: <span class="ruby-identifier">peer</span>.<span class="ruby-identifier">groups</span> = <span class="ruby-identifier">m</span>.<span class="ruby-identifier">groups</span>
248
+ 53: <span class="ruby-identifier">peer</span>.<span class="ruby-identifier">created_at</span> = <span class="ruby-identifier">peer</span>.<span class="ruby-identifier">updated_at</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
249
+ 54:
250
+ 55: <span class="ruby-comment cmt"># We should not start the #PeerConnection before registering because a running</span>
251
+ 56: <span class="ruby-comment cmt"># PeerConnection might already be registered. In this case, we'd have wasted a thread,</span>
252
+ 57: <span class="ruby-comment cmt"># so we'll let the registry handle startup (if it happens at all.)</span>
253
+ 58: <span class="ruby-comment cmt">#</span>
254
+ 59: <span class="ruby-comment cmt"># peer.start</span>
255
+ 60:
256
+ 61: <span class="ruby-comment cmt"># TODO validate peer entry is sane before registering it</span>
257
+ 62: <span class="ruby-ivar">@engine</span>.<span class="ruby-identifier">register_peer</span> <span class="ruby-identifier">peer</span>
258
+ 63: <span class="ruby-keyword kw">rescue</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
259
+ 64: <span class="ruby-identifier">putsd</span> <span class="ruby-node">&quot;Error during peer registration: #{e.message}&quot;</span>
260
+ 65: <span class="ruby-keyword kw">end</span>
261
+ 66: <span class="ruby-keyword kw">end</span>
262
+ 67: <span class="ruby-keyword kw">end</span>
263
+ 68: <span class="ruby-comment cmt"># putsd &quot;Event received!&quot;</span>
264
+ 69: <span class="ruby-keyword kw">end</span>
265
+ 70: <span class="ruby-keyword kw">ensure</span>
266
+ 71: <span class="ruby-identifier">putsd</span> <span class="ruby-value str">&quot;Closing presence listener socket.&quot;</span>
267
+ 72: <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">close</span>
268
+ 73: <span class="ruby-keyword kw">end</span>
269
+ 74: <span class="ruby-keyword kw">end</span></pre>
270
+ </div>
271
+
272
+ </div>
273
+
274
+
275
+
276
+
277
+ </div>
278
+
279
+
280
+ </div>
281
+
282
+
283
+ </div>
284
+
285
+
286
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
287
+
288
+ <p>Disabled; run with --debug to generate this.</p>
289
+
290
+ </div>
291
+
292
+ <div id="validator-badges">
293
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
294
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
295
+ Rdoc Generator</a> 1.1.6</small>.</p>
296
+ </div>
297
+
298
+ </body>
299
+ </html>
300
+