flotype-bridge 0.1.0.beta.2

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 (60) hide show
  1. data/README.md +6 -0
  2. data/Rakefile +24 -0
  3. data/doc/Bridge.html +954 -0
  4. data/doc/Bridge/Callback.html +495 -0
  5. data/doc/Bridge/CallbackRef.html +343 -0
  6. data/doc/Bridge/Conn.html +409 -0
  7. data/doc/Bridge/Core.html +762 -0
  8. data/doc/Bridge/LocalRef.html +509 -0
  9. data/doc/Bridge/Ref.html +647 -0
  10. data/doc/Bridge/Service.html +135 -0
  11. data/doc/Bridge/Sys.html +278 -0
  12. data/doc/Bridge/Util.html +746 -0
  13. data/doc/_index.html +202 -0
  14. data/doc/class_list.html +47 -0
  15. data/doc/classes/Bridge.html +263 -0
  16. data/doc/classes/Bridge.src/M000001.html +24 -0
  17. data/doc/classes/Bridge.src/M000002.html +18 -0
  18. data/doc/classes/Bridge.src/M000003.html +18 -0
  19. data/doc/classes/Bridge.src/M000004.html +20 -0
  20. data/doc/classes/Bridge.src/M000005.html +26 -0
  21. data/doc/classes/Bridge.src/M000006.html +22 -0
  22. data/doc/classes/Bridge.src/M000007.html +18 -0
  23. data/doc/classes/Bridge.src/M000008.html +18 -0
  24. data/doc/created.rid +1 -0
  25. data/doc/css/common.css +1 -0
  26. data/doc/css/full_list.css +55 -0
  27. data/doc/css/style.css +322 -0
  28. data/doc/file.README.html +71 -0
  29. data/doc/file_list.html +49 -0
  30. data/doc/files/lib/bridge_rb.html +108 -0
  31. data/doc/fr_class_index.html +27 -0
  32. data/doc/fr_file_index.html +27 -0
  33. data/doc/fr_method_index.html +34 -0
  34. data/doc/frames.html +13 -0
  35. data/doc/index.html +71 -0
  36. data/doc/js/app.js +205 -0
  37. data/doc/js/full_list.js +173 -0
  38. data/doc/js/jquery.js +16 -0
  39. data/doc/method_list.html +510 -0
  40. data/doc/rdoc-style.css +208 -0
  41. data/doc/top-level-namespace.html +105 -0
  42. data/examples/chat/chat_client.rb +41 -0
  43. data/examples/chat/chat_server.rb +24 -0
  44. data/examples/pong/pong.rb +29 -0
  45. data/flotype-bridge.gemspec +24 -0
  46. data/lib/bb/callback.rb +33 -0
  47. data/lib/bb/conn.rb +31 -0
  48. data/lib/bb/core.rb +109 -0
  49. data/lib/bb/localref.rb +37 -0
  50. data/lib/bb/ref.rb +49 -0
  51. data/lib/bb/svc.rb +7 -0
  52. data/lib/bb/sys.rb +17 -0
  53. data/lib/bb/util.rb +93 -0
  54. data/lib/bb/version.rb +3 -0
  55. data/lib/bridge.rb +130 -0
  56. data/rakelib/package.rake +4 -0
  57. data/rakelib/test.rake +8 -0
  58. data/tests/bb_test_helper.rb +3 -0
  59. data/tests/test_serialize.rb +4 -0
  60. metadata +196 -0
data/README.md ADDED
@@ -0,0 +1,6 @@
1
+ Flotype Bridge
2
+ ==============
3
+
4
+ Ruby client for Flotype Bridge.
5
+
6
+ To install: `rake && rake install`.
data/Rakefile ADDED
@@ -0,0 +1,24 @@
1
+ require 'rubygems'
2
+ require 'rubygems/installer'
3
+ GEMSPEC = Gem::Specification.load('flotype-bridge.gemspec')
4
+
5
+ require 'rake/clean'
6
+ task :clobber => :clean
7
+
8
+ desc "Build bridge, then run tests."
9
+ task :default => [:test, :package]
10
+
11
+ task :install => :package do
12
+ Gem::Installer.new("pkg/flotype-bridge-#{GEMSPEC.version}.gem").install
13
+ end
14
+
15
+ desc 'Generate documentation'
16
+ begin
17
+ require 'yard'
18
+ YARD::Rake::YardocTask.new do |t|
19
+ t.files = ['lib/**/*.rb', '-', 'docs/*.md']
20
+ t.options = ['--main', 'README.md', '--no-private']
21
+ end
22
+ rescue LoadError
23
+ task :yard do puts "Please install yard first!"; end
24
+ end
data/doc/Bridge.html ADDED
@@ -0,0 +1,954 @@
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
+ Module: Bridge
8
+
9
+ &mdash; Documentation by YARD 0.7.5
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="_index.html">Index (B)</a> &raquo;
37
+
38
+
39
+ <span class="title">Bridge</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Module: Bridge
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+ <dt class="r1">Included in:</dt>
74
+ <dd class="r1"><span class='object_link'><a href="Bridge/Service.html" title="Bridge::Service (module)">Service</a></span></dd>
75
+
76
+
77
+
78
+ <dt class="r2 last">Defined in:</dt>
79
+ <dd class="r2 last">lib/bb/svc.rb<span class="defines">,<br />
80
+ lib/bridge.rb,<br /> lib/bb/ref.rb,<br /> lib/bb/sys.rb,<br /> lib/bb/core.rb,<br /> lib/bb/conn.rb,<br /> lib/bb/util.rb,<br /> lib/bb/version.rb,<br /> lib/bb/callback.rb,<br /> lib/bb/localref.rb</span>
81
+ </dd>
82
+
83
+ </dl>
84
+ <div class="clear"></div>
85
+
86
+ <h2>Defined Under Namespace</h2>
87
+ <p class="children">
88
+
89
+
90
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Bridge/Conn.html" title="Bridge::Conn (module)">Conn</a></span>, <span class='object_link'><a href="Bridge/Core.html" title="Bridge::Core (module)">Core</a></span>, <span class='object_link'><a href="Bridge/Service.html" title="Bridge::Service (module)">Service</a></span>, <span class='object_link'><a href="Bridge/Sys.html" title="Bridge::Sys (module)">Sys</a></span>, <span class='object_link'><a href="Bridge/Util.html" title="Bridge::Util (module)">Util</a></span>
91
+
92
+
93
+
94
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Bridge/Callback.html" title="Bridge::Callback (class)">Callback</a></span>, <span class='object_link'><a href="Bridge/LocalRef.html" title="Bridge::LocalRef (class)">LocalRef</a></span>, <span class='object_link'><a href="Bridge/Ref.html" title="Bridge::Ref (class)">Ref</a></span>
95
+
96
+
97
+ </p>
98
+
99
+ <h2>Constant Summary</h2>
100
+
101
+ <dl class="constants">
102
+
103
+ <dt id="VERSION-constant" class="">VERSION =
104
+
105
+ </dt>
106
+ <dd><pre class="code"><span class='string val'>&quot;0.1.0.beta.2&quot;</span>
107
+ </pre></dd>
108
+
109
+ </dl>
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+ <h2>
120
+ Class Method Summary
121
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
122
+ </h2>
123
+
124
+ <ul class="summary">
125
+
126
+ <li class="public ">
127
+ <span class="summary_signature">
128
+
129
+ <a href="#client_id-class_method" title="client_id (class method)">+ (Object) <strong>client_id</strong> </a>
130
+
131
+
132
+
133
+ </span>
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+ <span class="summary_desc"><div class='inline'><p>
143
+ The client&#8217;s ID.
144
+ </p>
145
+ </div></span>
146
+
147
+ </li>
148
+
149
+
150
+ <li class="public ">
151
+ <span class="summary_signature">
152
+
153
+ <a href="#get_channel-class_method" title="get_channel (class method)">+ (Object) <strong>get_channel</strong>(channel) </a>
154
+
155
+
156
+
157
+ </span>
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+ <span class="summary_desc"><div class='inline'><p>
167
+ Returns a reference to the channel specified by `channel`.
168
+ </p>
169
+ </div></span>
170
+
171
+ </li>
172
+
173
+
174
+ <li class="public ">
175
+ <span class="summary_signature">
176
+
177
+ <a href="#get_service-class_method" title="get_service (class method)">+ (Object) <strong>get_service</strong>(svc) </a>
178
+
179
+
180
+
181
+ </span>
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+ <span class="summary_desc"><div class='inline'><p>
191
+ Returns a reference to the service specified by `svc`.
192
+ </p>
193
+ </div></span>
194
+
195
+ </li>
196
+
197
+
198
+ <li class="public ">
199
+ <span class="summary_signature">
200
+
201
+ <a href="#initialize-class_method" title="initialize (class method)">+ (Object) <strong>initialize</strong>(options = {}) </a>
202
+
203
+
204
+
205
+ </span>
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+ <span class="summary_desc"><div class='inline'></div></span>
215
+
216
+ </li>
217
+
218
+
219
+ <li class="public ">
220
+ <span class="summary_signature">
221
+
222
+ <a href="#join_channel-class_method" title="join_channel (class method)">+ (Object) <strong>join_channel</strong>(channel, handler, fun = nil) </a>
223
+
224
+
225
+
226
+ </span>
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+ <span class="summary_desc"><div class='inline'><p>
236
+ Join the channel specified by `channel`.
237
+ </p>
238
+ </div></span>
239
+
240
+ </li>
241
+
242
+
243
+ <li class="public ">
244
+ <span class="summary_signature">
245
+
246
+ <a href="#leave_channel-class_method" title="leave_channel (class method)">+ (Object) <strong>leave_channel</strong>(channel, handler, fun = nil) </a>
247
+
248
+
249
+
250
+ </span>
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+ <span class="summary_desc"><div class='inline'><p>
260
+ Leave a channel.
261
+ </p>
262
+ </div></span>
263
+
264
+ </li>
265
+
266
+
267
+ <li class="public ">
268
+ <span class="summary_signature">
269
+
270
+ <a href="#options-class_method" title="options (class method)">+ (Object) <strong>options</strong> </a>
271
+
272
+
273
+
274
+ </span>
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+ <span class="summary_desc"><div class='inline'><p>
284
+ Accessor for @options.
285
+ </p>
286
+ </div></span>
287
+
288
+ </li>
289
+
290
+
291
+ <li class="public ">
292
+ <span class="summary_signature">
293
+
294
+ <a href="#publish_service-class_method" title="publish_service (class method)">+ (Object) <strong>publish_service</strong>(svc, handler, fun = nil) </a>
295
+
296
+
297
+
298
+ </span>
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+ <span class="summary_desc"><div class='inline'><p>
308
+ Broadcasts the availability of certain functionality specified by a.
309
+ </p>
310
+ </div></span>
311
+
312
+ </li>
313
+
314
+
315
+ <li class="public ">
316
+ <span class="summary_signature">
317
+
318
+ <a href="#ready-class_method" title="ready (class method)">+ (Object) <strong>ready</strong>(fun) </a>
319
+
320
+
321
+
322
+ </span>
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+ <span class="summary_desc"><div class='inline'><p>
332
+ Similar to $(document).ready of jQuery as well as now.ready: takes.
333
+ </p>
334
+ </div></span>
335
+
336
+ </li>
337
+
338
+
339
+ <li class="public ">
340
+ <span class="summary_signature">
341
+
342
+ <a href="#send-class_method" title="send (class method)">+ (Object) <strong>send</strong>(dest, args) </a>
343
+
344
+
345
+
346
+ </span>
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+ <span class="summary_desc"><div class='inline'><p>
356
+ Calls a remote function specified by `dest` with `args`.
357
+ </p>
358
+ </div></span>
359
+
360
+ </li>
361
+
362
+
363
+ </ul>
364
+
365
+
366
+
367
+
368
+ <div id="class_method_details" class="method_details_list">
369
+ <h2>Class Method Details</h2>
370
+
371
+
372
+ <div class="method_details first">
373
+ <p class="signature first" id="client_id-class_method">
374
+
375
+ + (<tt>Object</tt>) <strong>client_id</strong>
376
+
377
+
378
+
379
+ </p><div class="docstring">
380
+ <div class="discussion">
381
+ <p>
382
+ The client&#8217;s ID.
383
+ </p>
384
+
385
+
386
+ </div>
387
+ </div>
388
+ <div class="tags">
389
+
390
+
391
+ </div><table class="source_code">
392
+ <tr>
393
+ <td>
394
+ <pre class="lines">
395
+
396
+
397
+ 119
398
+ 120
399
+ 121</pre>
400
+ </td>
401
+ <td>
402
+ <pre class="code"><span class="info file"># File 'lib/bridge.rb', line 119</span>
403
+
404
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_client_id identifier id'>client_id</span>
405
+ <span class='rubyid_Core constant id'>Core</span><span class='colon2 op'>::</span><span class='rubyid_client_id identifier id'>client_id</span>
406
+ <span class='rubyid_end end kw'>end</span>
407
+ </pre>
408
+ </td>
409
+ </tr>
410
+ </table>
411
+ </div>
412
+
413
+ <div class="method_details ">
414
+ <p class="signature " id="get_channel-class_method">
415
+
416
+ + (<tt>Object</tt>) <strong>get_channel</strong>(channel)
417
+
418
+
419
+
420
+ </p><div class="docstring">
421
+ <div class="discussion">
422
+ <p>
423
+ Returns a reference to the channel specified by `channel`.
424
+ </p>
425
+
426
+
427
+ </div>
428
+ </div>
429
+ <div class="tags">
430
+
431
+
432
+ </div><table class="source_code">
433
+ <tr>
434
+ <td>
435
+ <pre class="lines">
436
+
437
+
438
+ 114
439
+ 115
440
+ 116</pre>
441
+ </td>
442
+ <td>
443
+ <pre class="code"><span class="info file"># File 'lib/bridge.rb', line 114</span>
444
+
445
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_get_channel identifier id'>get_channel</span> <span class='rubyid_channel identifier id'>channel</span>
446
+ <span class='rubyid_Core constant id'>Core</span><span class='colon2 op'>::</span><span class='rubyid_lookup identifier id'>lookup</span> <span class='lbrack token'>[</span><span class='string val'>'channel'</span><span class='comma token'>,</span> <span class='rubyid_channel identifier id'>channel</span><span class='comma token'>,</span> <span class='dstring node'>&quot;channel:#{channel}&quot;</span><span class='rbrack token'>]</span>
447
+ <span class='rubyid_end end kw'>end</span>
448
+ </pre>
449
+ </td>
450
+ </tr>
451
+ </table>
452
+ </div>
453
+
454
+ <div class="method_details ">
455
+ <p class="signature " id="get_service-class_method">
456
+
457
+ + (<tt>Object</tt>) <strong>get_service</strong>(svc)
458
+
459
+
460
+
461
+ </p><div class="docstring">
462
+ <div class="discussion">
463
+ <p>
464
+ Returns a reference to the service specified by `svc`.
465
+ </p>
466
+
467
+
468
+ </div>
469
+ </div>
470
+ <div class="tags">
471
+
472
+
473
+ </div><table class="source_code">
474
+ <tr>
475
+ <td>
476
+ <pre class="lines">
477
+
478
+
479
+ 109
480
+ 110
481
+ 111</pre>
482
+ </td>
483
+ <td>
484
+ <pre class="code"><span class="info file"># File 'lib/bridge.rb', line 109</span>
485
+
486
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_get_service identifier id'>get_service</span> <span class='rubyid_svc identifier id'>svc</span>
487
+ <span class='rubyid_Core constant id'>Core</span><span class='colon2 op'>::</span><span class='rubyid_lookup identifier id'>lookup</span> <span class='lbrack token'>[</span><span class='string val'>'named'</span><span class='comma token'>,</span> <span class='rubyid_svc identifier id'>svc</span><span class='comma token'>,</span> <span class='rubyid_svc identifier id'>svc</span><span class='rbrack token'>]</span>
488
+ <span class='rubyid_end end kw'>end</span>
489
+ </pre>
490
+ </td>
491
+ </tr>
492
+ </table>
493
+ </div>
494
+
495
+ <div class="method_details ">
496
+ <p class="signature " id="initialize-class_method">
497
+
498
+ + (<tt>Object</tt>) <strong>initialize</strong>(options = {})
499
+
500
+
501
+
502
+ </p><table class="source_code">
503
+ <tr>
504
+ <td>
505
+ <pre class="lines">
506
+
507
+
508
+ 23
509
+ 24
510
+ 25
511
+ 26
512
+ 27
513
+ 28
514
+ 29
515
+ 30
516
+ 31
517
+ 32
518
+ 33
519
+ 34
520
+ 35
521
+ 36
522
+ 37
523
+ 38
524
+ 39
525
+ 40
526
+ 41
527
+ 42
528
+ 43
529
+ 44
530
+ 45
531
+ 46
532
+ 47
533
+ 48</pre>
534
+ </td>
535
+ <td>
536
+ <pre class="code"><span class="info file"># File 'lib/bridge.rb', line 23</span>
537
+
538
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_options identifier id'>options</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
539
+ <span class='rubyid_Util constant id'>Util</span><span class='colon2 op'>::</span><span class='rubyid_log identifier id'>log</span> <span class='string val'>'initialize called.'</span>
540
+ <span class='rubyid_@options ivar id'>@options</span> <span class='assign token'>=</span> <span class='rubyid_@options ivar id'>@options</span><span class='dot token'>.</span><span class='rubyid_merge identifier id'>merge</span><span class='lparen token'>(</span><span class='rubyid_options identifier id'>options</span><span class='rparen token'>)</span>
541
+
542
+ <span class='rubyid_if if kw'>if</span> <span class='notop op'>!</span><span class='lparen token'>(</span><span class='rubyid_@options ivar id'>@options</span><span class='dot token'>.</span><span class='rubyid_has_key? fid id'>has_key?</span> <span class='string val'>'api_key'</span><span class='rparen token'>)</span>
543
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>'No API key specified.'</span>
544
+ <span class='rubyid_end end kw'>end</span>
545
+
546
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_Util constant id'>Util</span><span class='colon2 op'>::</span><span class='rubyid_has_keys? fid id'>has_keys?</span><span class='lparen token'>(</span><span class='rubyid_@options ivar id'>@options</span><span class='comma token'>,</span> <span class='string val'>'host'</span><span class='comma token'>,</span> <span class='string val'>'port'</span><span class='rparen token'>)</span>
547
+ <span class='rubyid_EM constant id'>EM</span><span class='colon2 op'>::</span><span class='rubyid_connect identifier id'>connect</span><span class='lparen token'>(</span><span class='rubyid_@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='string val'>'host'</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='string val'>'port'</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_Bridge constant id'>Bridge</span><span class='colon2 op'>::</span><span class='rubyid_Conn constant id'>Conn</span><span class='rparen token'>)</span>
548
+ <span class='rubyid_else else kw'>else</span>
549
+ <span class='comment val'># Support for redirector.</span>
550
+ <span class='rubyid_conn identifier id'>conn</span> <span class='assign token'>=</span> <span class='rubyid_EM constant id'>EM</span><span class='colon2 op'>::</span><span class='rubyid_Protocols constant id'>Protocols</span><span class='colon2 op'>::</span><span class='rubyid_HttpClient2 constant id'>HttpClient2</span><span class='dot token'>.</span><span class='rubyid_connect identifier id'>connect</span><span class='lparen token'>(</span><span class='rubyid_@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='string val'>'redir_host'</span><span class='rbrack token'>]</span><span class='comma token'>,</span>
551
+ <span class='rubyid_@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='string val'>'redir_port'</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
552
+ <span class='rubyid_req identifier id'>req</span> <span class='assign token'>=</span> <span class='rubyid_conn identifier id'>conn</span><span class='dot token'>.</span><span class='rubyid_get identifier id'>get</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='symbol val'>:uri</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;/redirect/#{@options['api_key']}&quot;</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
553
+ <span class='rubyid_req identifier id'>req</span><span class='dot token'>.</span><span class='rubyid_callback identifier id'>callback</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_obj identifier id'>obj</span><span class='bitor op'>|</span>
554
+ <span class='rubyid_obj identifier id'>obj</span> <span class='assign token'>=</span> <span class='rubyid_JSON constant id'>JSON</span><span class='colon2 op'>::</span><span class='rubyid_parse identifier id'>parse</span> <span class='rubyid_obj identifier id'>obj</span><span class='dot token'>.</span><span class='rubyid_content identifier id'>content</span>
555
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_obj identifier id'>obj</span><span class='dot token'>.</span><span class='rubyid_has_key? fid id'>has_key?</span><span class='lparen token'>(</span><span class='string val'>'data'</span><span class='rparen token'>)</span>
556
+ <span class='rubyid_obj identifier id'>obj</span> <span class='assign token'>=</span> <span class='rubyid_obj identifier id'>obj</span><span class='lbrack token'>[</span><span class='string val'>'data'</span><span class='rbrack token'>]</span>
557
+ <span class='rubyid_EM constant id'>EM</span><span class='colon2 op'>::</span><span class='rubyid_connect identifier id'>connect</span><span class='lparen token'>(</span><span class='rubyid_obj identifier id'>obj</span><span class='lbrack token'>[</span><span class='string val'>'bridge_host'</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_obj identifier id'>obj</span><span class='lbrack token'>[</span><span class='string val'>'bridge_port'</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_Bridge constant id'>Bridge</span><span class='colon2 op'>::</span><span class='rubyid_Conn constant id'>Conn</span><span class='rparen token'>)</span>
558
+ <span class='rubyid_else else kw'>else</span>
559
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_Exception constant id'>Exception</span><span class='comma token'>,</span> <span class='string val'>'Invalid API key.'</span>
560
+ <span class='rubyid_end end kw'>end</span>
561
+ <span class='rubyid_end end kw'>end</span>
562
+ <span class='rubyid_end end kw'>end</span>
563
+ <span class='rubyid_end end kw'>end</span>
564
+ </pre>
565
+ </td>
566
+ </tr>
567
+ </table>
568
+ </div>
569
+
570
+ <div class="method_details ">
571
+ <p class="signature " id="join_channel-class_method">
572
+
573
+ + (<tt>Object</tt>) <strong>join_channel</strong>(channel, handler, fun = nil)
574
+
575
+
576
+
577
+ </p><div class="docstring">
578
+ <div class="discussion">
579
+ <p>
580
+ Join the channel specified by `channel`. Messages from this channel
581
+ </p>
582
+ <pre class="code ruby"><code>
583
+ <span class='rubyid_will identifier id'>will</span> <span class='rubyid_be identifier id'>be</span> <span class='rubyid_passed identifier id'>passed</span> <span class='rubyid_in in kw'>in</span> <span class='rubyid_to identifier id'>to</span> <span class='rubyid_a identifier id'>a</span> <span class='rubyid_handler identifier id'>handler</span> <span class='rubyid_specified identifier id'>specified</span> <span class='rubyid_by identifier id'>by</span> <span class='xstring val'>`handler`</span><span class='dot token'>.</span> <span class='rubyid_The constant id'>The</span> <span class='rubyid_callback identifier id'>callback</span>
584
+ <span class='xstring val'>`fun`</span> <span class='rubyid_is identifier id'>is</span> <span class='rubyid_to identifier id'>to</span> <span class='rubyid_be identifier id'>be</span> <span class='rubyid_called identifier id'>called</span> <span class='rubyid_to identifier id'>to</span> <span class='rubyid_confirm identifier id'>confirm</span> <span class='rubyid_successful identifier id'>successful</span> <span class='rubyid_joining identifier id'>joining</span> <span class='rubyid_of identifier id'>of</span> <span class='rubyid_the identifier id'>the</span> <span class='rubyid_channel identifier id'>channel</span><span class='dot token'>.</span>
585
+ </code></pre>
586
+
587
+
588
+ </div>
589
+ </div>
590
+ <div class="tags">
591
+
592
+
593
+ </div><table class="source_code">
594
+ <tr>
595
+ <td>
596
+ <pre class="lines">
597
+
598
+
599
+ 91
600
+ 92
601
+ 93
602
+ 94
603
+ 95
604
+ 96
605
+ 97</pre>
606
+ </td>
607
+ <td>
608
+ <pre class="code"><span class="info file"># File 'lib/bridge.rb', line 91</span>
609
+
610
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_join_channel identifier id'>join_channel</span> <span class='rubyid_channel identifier id'>channel</span><span class='comma token'>,</span> <span class='rubyid_handler identifier id'>handler</span><span class='comma token'>,</span> <span class='rubyid_fun identifier id'>fun</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span>
611
+ <span class='rubyid_obj identifier id'>obj</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span> <span class='symbol val'>:name</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_svc identifier id'>svc</span><span class='comma token'>,</span> <span class='symbol val'>:handler</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_Util constant id'>Util</span><span class='colon2 op'>::</span><span class='rubyid_local_ref identifier id'>local_ref</span><span class='lparen token'>(</span><span class='rubyid_handler identifier id'>handler</span><span class='rparen token'>)</span><span class='rbrace token'>}</span>
612
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_fun identifier id'>fun</span><span class='dot token'>.</span><span class='rubyid_respond_to? fid id'>respond_to?</span> <span class='colon op'>:</span><span class='rubyid_call identifier id'>call</span>
613
+ <span class='rubyid_obj identifier id'>obj</span><span class='lbrack token'>[</span><span class='symbol val'>:callback</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_Util constant id'>Util</span><span class='colon2 op'>::</span><span class='rubyid_cb identifier id'>cb</span><span class='lparen token'>(</span><span class='rubyid_fun identifier id'>fun</span><span class='rparen token'>)</span>
614
+ <span class='rubyid_end end kw'>end</span>
615
+ <span class='rubyid_Core constant id'>Core</span><span class='colon2 op'>::</span><span class='rubyid_command identifier id'>command</span><span class='lparen token'>(</span><span class='symbol val'>:JOINCHANNEL</span><span class='comma token'>,</span> <span class='rubyid_obj identifier id'>obj</span><span class='rparen token'>)</span>
616
+ <span class='rubyid_end end kw'>end</span>
617
+ </pre>
618
+ </td>
619
+ </tr>
620
+ </table>
621
+ </div>
622
+
623
+ <div class="method_details ">
624
+ <p class="signature " id="leave_channel-class_method">
625
+
626
+ + (<tt>Object</tt>) <strong>leave_channel</strong>(channel, handler, fun = nil)
627
+
628
+
629
+
630
+ </p><div class="docstring">
631
+ <div class="discussion">
632
+ <p>
633
+ Leave a channel.
634
+ </p>
635
+
636
+
637
+ </div>
638
+ </div>
639
+ <div class="tags">
640
+
641
+
642
+ </div><table class="source_code">
643
+ <tr>
644
+ <td>
645
+ <pre class="lines">
646
+
647
+
648
+ 100
649
+ 101
650
+ 102
651
+ 103
652
+ 104
653
+ 105
654
+ 106</pre>
655
+ </td>
656
+ <td>
657
+ <pre class="code"><span class="info file"># File 'lib/bridge.rb', line 100</span>
658
+
659
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_leave_channel identifier id'>leave_channel</span> <span class='rubyid_channel identifier id'>channel</span><span class='comma token'>,</span> <span class='rubyid_handler identifier id'>handler</span><span class='comma token'>,</span> <span class='rubyid_fun identifier id'>fun</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span>
660
+ <span class='rubyid_obj identifier id'>obj</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span> <span class='symbol val'>:name</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_svc identifier id'>svc</span><span class='comma token'>,</span> <span class='symbol val'>:handler</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_Util constant id'>Util</span><span class='colon2 op'>::</span><span class='rubyid_local_ref identifier id'>local_ref</span><span class='lparen token'>(</span><span class='rubyid_handler identifier id'>handler</span><span class='rparen token'>)</span><span class='rbrace token'>}</span>
661
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_fun identifier id'>fun</span><span class='dot token'>.</span><span class='rubyid_respond_to? fid id'>respond_to?</span> <span class='colon op'>:</span><span class='rubyid_call identifier id'>call</span>
662
+ <span class='rubyid_obj identifier id'>obj</span><span class='lbrack token'>[</span><span class='symbol val'>:callback</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_Util constant id'>Util</span><span class='colon2 op'>::</span><span class='rubyid_cb identifier id'>cb</span><span class='lparen token'>(</span><span class='rubyid_fun identifier id'>fun</span><span class='rparen token'>)</span>
663
+ <span class='rubyid_end end kw'>end</span>
664
+ <span class='rubyid_Core constant id'>Core</span><span class='colon2 op'>::</span><span class='rubyid_command identifier id'>command</span><span class='lparen token'>(</span><span class='symbol val'>:LEAVECHANNEL</span><span class='comma token'>,</span> <span class='rubyid_obj identifier id'>obj</span><span class='rparen token'>)</span>
665
+ <span class='rubyid_end end kw'>end</span>
666
+ </pre>
667
+ </td>
668
+ </tr>
669
+ </table>
670
+ </div>
671
+
672
+ <div class="method_details ">
673
+ <p class="signature " id="options-class_method">
674
+
675
+ + (<tt>Object</tt>) <strong>options</strong>
676
+
677
+
678
+
679
+ </p><div class="docstring">
680
+ <div class="discussion">
681
+ <p>
682
+ Accessor for @options.
683
+ </p>
684
+
685
+
686
+ </div>
687
+ </div>
688
+ <div class="tags">
689
+
690
+ <h3>Returns:</h3>
691
+ <ul class="return">
692
+
693
+ <li>
694
+
695
+
696
+ <span class='type'>(<tt>Object</tt>)</span>
697
+
698
+
699
+
700
+ &mdash;
701
+ <div class='inline'><p>
702
+ options
703
+ </p>
704
+ </div>
705
+
706
+ </li>
707
+
708
+ </ul>
709
+
710
+ </div><table class="source_code">
711
+ <tr>
712
+ <td>
713
+ <pre class="lines">
714
+
715
+
716
+ 52
717
+ 53
718
+ 54</pre>
719
+ </td>
720
+ <td>
721
+ <pre class="code"><span class="info file"># File 'lib/bridge.rb', line 52</span>
722
+
723
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_options identifier id'>options</span>
724
+ <span class='rubyid_@options ivar id'>@options</span>
725
+ <span class='rubyid_end end kw'>end</span>
726
+ </pre>
727
+ </td>
728
+ </tr>
729
+ </table>
730
+ </div>
731
+
732
+ <div class="method_details ">
733
+ <p class="signature " id="publish_service-class_method">
734
+
735
+ + (<tt>Object</tt>) <strong>publish_service</strong>(svc, handler, fun = nil)
736
+
737
+
738
+
739
+ </p><div class="docstring">
740
+ <div class="discussion">
741
+ <p>
742
+ Broadcasts the availability of certain functionality specified by a
743
+ </p>
744
+ <pre class="code ruby"><code>
745
+ <span class='rubyid_proc identifier id'>proc</span> <span class='xstring val'>`fun`</span> <span class='rubyid_under identifier id'>under</span> <span class='rubyid_the identifier id'>the</span> <span class='rubyid_name identifier id'>name</span> <span class='rubyid_of identifier id'>of</span> <span class='xstring val'>`svc`</span><span class='dot token'>.</span>
746
+ </code></pre>
747
+
748
+
749
+ </div>
750
+ </div>
751
+ <div class="tags">
752
+
753
+
754
+ </div><table class="source_code">
755
+ <tr>
756
+ <td>
757
+ <pre class="lines">
758
+
759
+
760
+ 75
761
+ 76
762
+ 77
763
+ 78
764
+ 79
765
+ 80
766
+ 81
767
+ 82
768
+ 83
769
+ 84
770
+ 85
771
+ 86</pre>
772
+ </td>
773
+ <td>
774
+ <pre class="code"><span class="info file"># File 'lib/bridge.rb', line 75</span>
775
+
776
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_publish_service identifier id'>publish_service</span> <span class='rubyid_svc identifier id'>svc</span><span class='comma token'>,</span> <span class='rubyid_handler identifier id'>handler</span><span class='comma token'>,</span> <span class='rubyid_fun identifier id'>fun</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span>
777
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_svc identifier id'>svc</span> <span class='eq op'>==</span> <span class='string val'>'system'</span>
778
+ <span class='rubyid_Util constant id'>Util</span><span class='colon2 op'>::</span><span class='rubyid_err identifier id'>err</span><span class='lparen token'>(</span><span class='dstring node'>&quot;Invalid service name: #{svc}&quot;</span><span class='rparen token'>)</span>
779
+ <span class='rubyid_else else kw'>else</span>
780
+ <span class='rubyid_obj identifier id'>obj</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span> <span class='symbol val'>:name</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_svc identifier id'>svc</span><span class='rbrace token'>}</span>
781
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_fun identifier id'>fun</span><span class='dot token'>.</span><span class='rubyid_respond_to? fid id'>respond_to?</span> <span class='colon op'>:</span><span class='rubyid_call identifier id'>call</span>
782
+ <span class='rubyid_obj identifier id'>obj</span><span class='lbrack token'>[</span><span class='symbol val'>:callback</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_Util constant id'>Util</span><span class='colon2 op'>::</span><span class='rubyid_cb identifier id'>cb</span><span class='lparen token'>(</span><span class='rubyid_fun identifier id'>fun</span><span class='rparen token'>)</span>
783
+ <span class='rubyid_end end kw'>end</span>
784
+ <span class='rubyid_Core constant id'>Core</span><span class='colon2 op'>::</span><span class='rubyid_command identifier id'>command</span><span class='lparen token'>(</span><span class='symbol val'>:JOINWORKERPOOL</span><span class='comma token'>,</span> <span class='rubyid_obj identifier id'>obj</span><span class='rparen token'>)</span>
785
+ <span class='rubyid_Core constant id'>Core</span><span class='colon2 op'>::</span><span class='rubyid_store identifier id'>store</span><span class='lparen token'>(</span><span class='rubyid_svc identifier id'>svc</span><span class='comma token'>,</span> <span class='rubyid_Bridge constant id'>Bridge</span><span class='colon2 op'>::</span><span class='rubyid_LocalRef constant id'>LocalRef</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='lbrack token'>[</span><span class='rubyid_svc identifier id'>svc</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_handler identifier id'>handler</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
786
+ <span class='rubyid_end end kw'>end</span>
787
+ <span class='rubyid_end end kw'>end</span>
788
+ </pre>
789
+ </td>
790
+ </tr>
791
+ </table>
792
+ </div>
793
+
794
+ <div class="method_details ">
795
+ <p class="signature " id="ready-class_method">
796
+
797
+ + (<tt>Object</tt>) <strong>ready</strong>(fun)
798
+
799
+
800
+
801
+ </p><div class="docstring">
802
+ <div class="discussion">
803
+ <p>
804
+ Similar to $(document).ready of jQuery as well as now.ready: takes
805
+ </p>
806
+ <pre class="code ruby"><code>
807
+ <span class='rubyid_callbacks identifier id'>callbacks</span> <span class='rubyid_that identifier id'>that</span> <span class='rubyid_it identifier id'>it</span> <span class='rubyid_will identifier id'>will</span> <span class='rubyid_call identifier id'>call</span> <span class='rubyid_when when kw'>when</span> <span class='rubyid_the identifier id'>the</span> <span class='rubyid_connection identifier id'>connection</span> <span class='rubyid_handshake identifier id'>handshake</span> <span class='rubyid_has identifier id'>has</span> <span class='rubyid_been identifier id'>been</span>
808
+ <span class='rubyid_completed identifier id'>completed</span><span class='dot token'>.</span>
809
+ </code></pre>
810
+
811
+
812
+ </div>
813
+ </div>
814
+ <div class="tags">
815
+ <h3>Parameters:</h3>
816
+ <ul class="param">
817
+
818
+ <li>
819
+
820
+ <span class='name'>fun</span>
821
+
822
+
823
+ <span class='type'>(<tt>#call</tt>)</span>
824
+
825
+
826
+
827
+ &mdash;
828
+ <div class='inline'><p>
829
+ Callback to be called when the server connects.
830
+ </p>
831
+ </div>
832
+
833
+ </li>
834
+
835
+ </ul>
836
+
837
+
838
+ </div><table class="source_code">
839
+ <tr>
840
+ <td>
841
+ <pre class="lines">
842
+
843
+
844
+ 60
845
+ 61
846
+ 62</pre>
847
+ </td>
848
+ <td>
849
+ <pre class="code"><span class="info file"># File 'lib/bridge.rb', line 60</span>
850
+
851
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_ready identifier id'>ready</span> <span class='rubyid_fun identifier id'>fun</span>
852
+ <span class='rubyid_Core constant id'>Core</span><span class='colon2 op'>::</span><span class='rubyid_enqueue identifier id'>enqueue</span> <span class='rubyid_fun identifier id'>fun</span>
853
+ <span class='rubyid_end end kw'>end</span>
854
+ </pre>
855
+ </td>
856
+ </tr>
857
+ </table>
858
+ </div>
859
+
860
+ <div class="method_details ">
861
+ <p class="signature " id="send-class_method">
862
+
863
+ + (<tt>Object</tt>) <strong>send</strong>(dest, args)
864
+
865
+
866
+
867
+ </p><div class="docstring">
868
+ <div class="discussion">
869
+ <p>
870
+ Calls a remote function specified by `dest` with `args`.
871
+ </p>
872
+
873
+
874
+ </div>
875
+ </div>
876
+ <div class="tags">
877
+ <h3>Parameters:</h3>
878
+ <ul class="param">
879
+
880
+ <li>
881
+
882
+ <span class='name'>dest</span>
883
+
884
+
885
+ <span class='type'>(<tt><span class='object_link'><a href="Bridge/Ref.html" title="Bridge::Ref (class)">Ref</a></span></tt>)</span>
886
+
887
+
888
+
889
+ &mdash;
890
+ <div class='inline'><p>
891
+ The identifier of the remote function to call.
892
+ </p>
893
+ </div>
894
+
895
+ </li>
896
+
897
+ <li>
898
+
899
+ <span class='name'>args</span>
900
+
901
+
902
+ <span class='type'>(<tt>Array</tt>)</span>
903
+
904
+
905
+
906
+ &mdash;
907
+ <div class='inline'><p>
908
+ Arguments to be passed to `dest`.
909
+ </p>
910
+ </div>
911
+
912
+ </li>
913
+
914
+ </ul>
915
+
916
+
917
+ </div><table class="source_code">
918
+ <tr>
919
+ <td>
920
+ <pre class="lines">
921
+
922
+
923
+ 67
924
+ 68
925
+ 69
926
+ 70
927
+ 71</pre>
928
+ </td>
929
+ <td>
930
+ <pre class="code"><span class="info file"># File 'lib/bridge.rb', line 67</span>
931
+
932
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span> <span class='rubyid_dest identifier id'>dest</span><span class='comma token'>,</span> <span class='rubyid_args identifier id'>args</span>
933
+ <span class='rubyid_Core constant id'>Core</span><span class='colon2 op'>::</span><span class='rubyid_command identifier id'>command</span><span class='lparen token'>(</span><span class='symbol val'>:SEND</span><span class='comma token'>,</span>
934
+ <span class='lbrace token'>{</span> <span class='symbol val'>:args</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_Util constant id'>Util</span><span class='colon2 op'>::</span><span class='rubyid_serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='rubyid_args identifier id'>args</span><span class='rparen token'>)</span><span class='comma token'>,</span>
935
+ <span class='symbol val'>:destination</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_dest identifier id'>dest</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span>
936
+ <span class='rubyid_end end kw'>end</span>
937
+ </pre>
938
+ </td>
939
+ </tr>
940
+ </table>
941
+ </div>
942
+
943
+ </div>
944
+
945
+ </div>
946
+
947
+ <div id="footer">
948
+ Generated on Sun Mar 4 11:14:11 2012 by
949
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
950
+ 0.7.5 (ruby-1.8.7).
951
+ </div>
952
+
953
+ </body>
954
+ </html>