celluloid_pubsub 0.0.5 → 0.0.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/.rubocop.yml +1 -1
- data/Guardfile +4 -0
- data/Rakefile +12 -1
- data/bin/inch +16 -0
- data/bin/sparkr +16 -0
- data/celluloid_pubsub.gemspec +2 -1
- data/doc/CelluloidPubsub/Client/PubSubWorker.html +3676 -0
- data/doc/CelluloidPubsub/Client.html +340 -0
- data/doc/CelluloidPubsub/Reactor.html +3502 -0
- data/doc/CelluloidPubsub/Registry.html +234 -0
- data/doc/CelluloidPubsub/VERSION.html +204 -0
- data/doc/CelluloidPubsub/WebServer.html +4275 -0
- data/doc/CelluloidPubsub.html +225 -0
- data/doc/_index.html +184 -0
- data/doc/class_list.html +58 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +339 -0
- data/doc/file.README.html +226 -0
- data/doc/file_list.html +60 -0
- data/doc/frames.html +26 -0
- data/doc/index.html +226 -0
- data/doc/js/app.js +219 -0
- data/doc/js/full_list.js +181 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +357 -0
- data/doc/top-level-namespace.html +112 -0
- data/examples/simple_test.rb +3 -1
- data/lib/celluloid_pubsub/client_pubsub.rb +117 -0
- data/lib/celluloid_pubsub/reactor.rb +138 -7
- data/lib/celluloid_pubsub/registry.rb +3 -0
- data/lib/celluloid_pubsub/version.rb +15 -2
- data/lib/celluloid_pubsub/web_server.rb +112 -0
- metadata +41 -10
|
@@ -0,0 +1,340 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Class: CelluloidPubsub::Client
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.7.6
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '../';
|
|
20
|
+
framesUrl = "../frames.html#!CelluloidPubsub/Client.html";
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="../_index.html">Index (C)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../CelluloidPubsub.html" title="CelluloidPubsub (module)">CelluloidPubsub</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">Client</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
|
46
|
+
href="../class_list.html">
|
|
47
|
+
Class List
|
|
48
|
+
</a>
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
|
51
|
+
href="../method_list.html">
|
|
52
|
+
Method List
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
|
56
|
+
href="../file_list.html">
|
|
57
|
+
File List
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<iframe id="search_frame"></iframe>
|
|
65
|
+
|
|
66
|
+
<div id="content"><h1>Class: CelluloidPubsub::Client
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
<dt class="r1">Inherits:</dt>
|
|
75
|
+
<dd class="r1">
|
|
76
|
+
<span class="inheritName">Object</span>
|
|
77
|
+
|
|
78
|
+
<ul class="fullTree">
|
|
79
|
+
<li>Object</li>
|
|
80
|
+
|
|
81
|
+
<li class="next">CelluloidPubsub::Client</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
<dt class="r2 last">Defined in:</dt>
|
|
97
|
+
<dd class="r2 last">lib/celluloid_pubsub/client_pubsub.rb</dd>
|
|
98
|
+
|
|
99
|
+
</dl>
|
|
100
|
+
<div class="clear"></div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>class used to make a new connection in order to subscribe or publish to a
|
|
106
|
+
channel</p>
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</div>
|
|
110
|
+
</div>
|
|
111
|
+
<div class="tags">
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
</div><h2>Defined Under Namespace</h2>
|
|
115
|
+
<p class="children">
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Client/PubSubWorker.html" title="CelluloidPubsub::Client::PubSubWorker (class)">PubSubWorker</a></span>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</p>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
<h2>
|
|
133
|
+
Class Method Summary
|
|
134
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
135
|
+
</h2>
|
|
136
|
+
|
|
137
|
+
<ul class="summary">
|
|
138
|
+
|
|
139
|
+
<li class="public ">
|
|
140
|
+
<span class="summary_signature">
|
|
141
|
+
|
|
142
|
+
<a href="#connect-class_method" title="connect (class method)">+ (CelluloidPubsub::Client::PubSubWorker) <strong>connect</strong>(options = {}, &connect_blk) </a>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</span>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<span class="summary_desc"><div class='inline'>
|
|
157
|
+
<p>method used to make a new connection to the webserver after the connection
|
|
158
|
+
is opened it will execute the block that is passed as argument.</p>
|
|
159
|
+
</div></span>
|
|
160
|
+
|
|
161
|
+
</li>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
</ul>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<div id="class_method_details" class="method_details_list">
|
|
170
|
+
<h2>Class Method Details</h2>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<div class="method_details first">
|
|
174
|
+
<h3 class="signature first" id="connect-class_method">
|
|
175
|
+
|
|
176
|
+
+ (<tt><span class='object_link'><a href="Client/PubSubWorker.html" title="CelluloidPubsub::Client::PubSubWorker (class)">CelluloidPubsub::Client::PubSubWorker</a></span></tt>) <strong>connect</strong>(options = {}, &connect_blk)
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
</h3><div class="docstring">
|
|
183
|
+
<div class="discussion">
|
|
184
|
+
|
|
185
|
+
<p>method used to make a new connection to the webserver after the connection
|
|
186
|
+
is opened it will execute the block that is passed as argument</p>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
</div>
|
|
190
|
+
</div>
|
|
191
|
+
<div class="tags">
|
|
192
|
+
<p class="tag_title">Parameters:</p>
|
|
193
|
+
<ul class="param">
|
|
194
|
+
|
|
195
|
+
<li>
|
|
196
|
+
|
|
197
|
+
<span class='name'>options</span>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
—
|
|
207
|
+
<div class='inline'>
|
|
208
|
+
<p>the options that can be used to connect to webser and send additional data</p>
|
|
209
|
+
</div>
|
|
210
|
+
|
|
211
|
+
</li>
|
|
212
|
+
|
|
213
|
+
<li>
|
|
214
|
+
|
|
215
|
+
<span class='name'>connect_blk</span>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
<span class='type'>(<tt>Proc</tt>)</span>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
—
|
|
223
|
+
<div class='inline'>
|
|
224
|
+
<p>Block that will execute after the connection is opened</p>
|
|
225
|
+
</div>
|
|
226
|
+
|
|
227
|
+
</li>
|
|
228
|
+
|
|
229
|
+
</ul>
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
|
235
|
+
<ul class="option">
|
|
236
|
+
|
|
237
|
+
<li>
|
|
238
|
+
<span class="name">:actor</span>
|
|
239
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
240
|
+
<span class="default">
|
|
241
|
+
|
|
242
|
+
</span>
|
|
243
|
+
|
|
244
|
+
— <div class='inline'>
|
|
245
|
+
<p>The actor that made the connection</p>
|
|
246
|
+
</div>
|
|
247
|
+
|
|
248
|
+
</li>
|
|
249
|
+
|
|
250
|
+
<li>
|
|
251
|
+
<span class="name">:hostname</span>
|
|
252
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
253
|
+
<span class="default">
|
|
254
|
+
|
|
255
|
+
</span>
|
|
256
|
+
|
|
257
|
+
— <div class='inline'>
|
|
258
|
+
<p>The hostname on which the webserver runs on</p>
|
|
259
|
+
</div>
|
|
260
|
+
|
|
261
|
+
</li>
|
|
262
|
+
|
|
263
|
+
<li>
|
|
264
|
+
<span class="name">:port</span>
|
|
265
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
266
|
+
<span class="default">
|
|
267
|
+
|
|
268
|
+
</span>
|
|
269
|
+
|
|
270
|
+
— <div class='inline'>
|
|
271
|
+
<p>The port on which the webserver runs on</p>
|
|
272
|
+
</div>
|
|
273
|
+
|
|
274
|
+
</li>
|
|
275
|
+
|
|
276
|
+
<li>
|
|
277
|
+
<span class="name">:path</span>
|
|
278
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
279
|
+
<span class="default">
|
|
280
|
+
|
|
281
|
+
</span>
|
|
282
|
+
|
|
283
|
+
— <div class='inline'>
|
|
284
|
+
<p>The request path that the webserver accepts</p>
|
|
285
|
+
</div>
|
|
286
|
+
|
|
287
|
+
</li>
|
|
288
|
+
|
|
289
|
+
</ul>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<p class="tag_title">Returns:</p>
|
|
295
|
+
<ul class="return">
|
|
296
|
+
|
|
297
|
+
<li>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
<span class='type'>(<tt><span class='object_link'><a href="Client/PubSubWorker.html" title="CelluloidPubsub::Client::PubSubWorker (class)">CelluloidPubsub::Client::PubSubWorker</a></span></tt>)</span>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
</li>
|
|
305
|
+
|
|
306
|
+
</ul>
|
|
307
|
+
|
|
308
|
+
</div><table class="source_code">
|
|
309
|
+
<tr>
|
|
310
|
+
<td>
|
|
311
|
+
<pre class="lines">
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
192
|
|
315
|
+
193
|
|
316
|
+
194</pre>
|
|
317
|
+
</td>
|
|
318
|
+
<td>
|
|
319
|
+
<pre class="code"><span class="info file"># File 'lib/celluloid_pubsub/client_pubsub.rb', line 192</span>
|
|
320
|
+
|
|
321
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_connect_blk'>connect_blk</span><span class='rparen'>)</span>
|
|
322
|
+
<span class='const'>CelluloidPubsub</span><span class='op'>::</span><span class='const'>Client</span><span class='op'>::</span><span class='const'>PubSubWorker</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_connect_blk'>connect_blk</span><span class='rparen'>)</span>
|
|
323
|
+
<span class='kw'>end</span></pre>
|
|
324
|
+
</td>
|
|
325
|
+
</tr>
|
|
326
|
+
</table>
|
|
327
|
+
</div>
|
|
328
|
+
|
|
329
|
+
</div>
|
|
330
|
+
|
|
331
|
+
</div>
|
|
332
|
+
|
|
333
|
+
<div id="footer">
|
|
334
|
+
Generated on Fri Mar 13 12:25:43 2015 by
|
|
335
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
336
|
+
0.8.7.6 (ruby-2.0.0).
|
|
337
|
+
</div>
|
|
338
|
+
|
|
339
|
+
</body>
|
|
340
|
+
</html>
|