evented-memcache-client 1.0.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.
Files changed (43) hide show
  1. data/CHANGELOG +113 -0
  2. data/COPYING +348 -0
  3. data/README +75 -0
  4. data/Rakefile +123 -0
  5. data/doc/classes/EventMachine.html +146 -0
  6. data/doc/classes/EventMachine/Protocols.html +135 -0
  7. data/doc/classes/EventMachine/Protocols/Memcache.html +153 -0
  8. data/doc/classes/EventMachine/Protocols/Memcache/Client.html +121 -0
  9. data/doc/classes/EventMachine/Protocols/Memcache/Connectable.html +615 -0
  10. data/doc/classes/EventMachine/Protocols/Memcache/Connection.html +192 -0
  11. data/doc/classes/EventMachine/Protocols/Memcache/Sender.html +389 -0
  12. data/doc/classes/EventMachine/Protocols/Memcache/Server.html +463 -0
  13. data/doc/classes/EventMachine/Protocols/Memcache/TenaciousMC.html +277 -0
  14. data/doc/classes/MyHandler.html +197 -0
  15. data/doc/created.rid +1 -0
  16. data/doc/files/COPYING.html +473 -0
  17. data/doc/files/README.html +187 -0
  18. data/doc/files/extras/consumer_rb.html +110 -0
  19. data/doc/files/extras/producer_rb.html +110 -0
  20. data/doc/files/extras/server_rb.html +110 -0
  21. data/doc/files/lib/evented-memcache-client_rb.html +125 -0
  22. data/doc/files/lib/evented_memcache_client/client_rb.html +120 -0
  23. data/doc/files/lib/evented_memcache_client/connectable_rb.html +120 -0
  24. data/doc/files/lib/evented_memcache_client/connection_rb.html +120 -0
  25. data/doc/files/lib/evented_memcache_client/sender_rb.html +112 -0
  26. data/doc/files/lib/evented_memcache_client/server_rb.html +120 -0
  27. data/doc/files/lib/evented_memcache_client/tenacious_rb.html +120 -0
  28. data/doc/fr_class_index.html +36 -0
  29. data/doc/fr_file_index.html +38 -0
  30. data/doc/fr_method_index.html +66 -0
  31. data/doc/index.html +24 -0
  32. data/doc/rdoc-style.css +208 -0
  33. data/extras/consumer.rb +41 -0
  34. data/extras/producer.rb +22 -0
  35. data/extras/server.rb +33 -0
  36. data/lib/evented-memcache-client.rb +37 -0
  37. data/lib/evented_memcache_client/client.rb +36 -0
  38. data/lib/evented_memcache_client/connectable.rb +324 -0
  39. data/lib/evented_memcache_client/connection.rb +73 -0
  40. data/lib/evented_memcache_client/sender.rb +184 -0
  41. data/lib/evented_memcache_client/server.rb +118 -0
  42. data/lib/evented_memcache_client/tenacious.rb +106 -0
  43. metadata +115 -0
@@ -0,0 +1,463 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: EventMachine::Protocols::Memcache::Server</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">EventMachine::Protocols::Memcache::Server</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../../../files/lib/evented_memcache_client/server_rb.html">
59
+ lib/evented_memcache_client/server.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ Object
69
+ </td>
70
+ </tr>
71
+ </table>
72
+ </div>
73
+ <!-- banner header -->
74
+
75
+ <div id="bodyContent">
76
+
77
+
78
+
79
+ <div id="contextContent">
80
+
81
+
82
+
83
+ </div>
84
+
85
+ <div id="method-list">
86
+ <h3 class="section-bar">Methods</h3>
87
+
88
+ <div class="name-list">
89
+ <a href="#M000037">add</a>&nbsp;&nbsp;
90
+ <a href="#M000036">append</a>&nbsp;&nbsp;
91
+ <a href="#M000032">close</a>&nbsp;&nbsp;
92
+ <a href="#M000038">get</a>&nbsp;&nbsp;
93
+ <a href="#M000028">new</a>&nbsp;&nbsp;
94
+ <a href="#M000031">open</a>&nbsp;&nbsp;
95
+ <a href="#M000035">prepend</a>&nbsp;&nbsp;
96
+ <a href="#M000034">replace</a>&nbsp;&nbsp;
97
+ <a href="#M000033">set</a>&nbsp;&nbsp;
98
+ <a href="#M000029">start</a>&nbsp;&nbsp;
99
+ <a href="#M000030">stop</a>&nbsp;&nbsp;
100
+ <a href="#M000039">wait_for_connections</a>&nbsp;&nbsp;
101
+ </div>
102
+ </div>
103
+
104
+ </div>
105
+
106
+
107
+ <!-- if includes -->
108
+
109
+ <div id="section">
110
+
111
+
112
+ <div id="constants-list">
113
+ <h3 class="section-bar">Constants</h3>
114
+
115
+ <div class="name-list">
116
+ <table summary="Constants">
117
+ <tr class="top-aligned-row context-row">
118
+ <td class="context-item-name">DEFAULT_PORT</td>
119
+ <td>=</td>
120
+ <td class="context-item-value">22122</td>
121
+ </tr>
122
+ <tr class="top-aligned-row context-row">
123
+ <td class="context-item-name">DEFAULT_HOST</td>
124
+ <td>=</td>
125
+ <td class="context-item-value">'localhost'</td>
126
+ </tr>
127
+ </table>
128
+ </div>
129
+ </div>
130
+
131
+
132
+
133
+ <div id="attribute-list">
134
+ <h3 class="section-bar">Attributes</h3>
135
+
136
+ <div class="name-list">
137
+ <table>
138
+ <tr class="top-aligned-row context-row">
139
+ <td class="context-item-name">connections</td>
140
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
141
+ <td class="context-item-desc"></td>
142
+ </tr>
143
+ <tr class="top-aligned-row context-row">
144
+ <td class="context-item-name">host</td>
145
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
146
+ <td class="context-item-desc"></td>
147
+ </tr>
148
+ <tr class="top-aligned-row context-row">
149
+ <td class="context-item-name">port</td>
150
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
151
+ <td class="context-item-desc"></td>
152
+ </tr>
153
+ </table>
154
+ </div>
155
+ </div>
156
+
157
+
158
+
159
+ <!-- if method_list -->
160
+ <div id="methods">
161
+ <h3 class="section-bar">Public Class methods</h3>
162
+
163
+ <div id="method-M000028" class="method-detail">
164
+ <a name="M000028"></a>
165
+
166
+ <div class="method-heading">
167
+ <a href="#M000028" class="method-signature">
168
+ <span class="method-name">new</span><span class="method-args">(host=nil, port=nil)</span>
169
+ </a>
170
+ </div>
171
+
172
+ <div class="method-description">
173
+ <p>
174
+ Create a <a href="Server.html#M000028">new</a> memcache server listener, on
175
+ the specified host and port.
176
+ </p>
177
+ <p><a class="source-toggle" href="#"
178
+ onclick="toggleCode('M000028-source');return false;">[Source]</a></p>
179
+ <div class="method-source-code" id="M000028-source">
180
+ <pre>
181
+ <span class="ruby-comment cmt"># File lib/evented_memcache_client/server.rb, line 40</span>
182
+ 40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">host</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">port</span>=<span class="ruby-keyword kw">nil</span>)
183
+ 41: <span class="ruby-ivar">@host</span> = <span class="ruby-identifier">host</span> <span class="ruby-operator">||</span> <span class="ruby-constant">DEFAULT_HOST</span>
184
+ 42: <span class="ruby-ivar">@port</span> = <span class="ruby-identifier">port</span> <span class="ruby-operator">||</span> <span class="ruby-constant">DEFAULT_PORT</span>
185
+ 43: <span class="ruby-ivar">@connections</span> = []
186
+ 44: <span class="ruby-keyword kw">end</span>
187
+ </pre>
188
+ </div>
189
+ </div>
190
+ </div>
191
+
192
+ <h3 class="section-bar">Public Instance methods</h3>
193
+
194
+ <div id="method-M000037" class="method-detail">
195
+ <a name="M000037"></a>
196
+
197
+ <div class="method-heading">
198
+ <span class="method-name">add</span><span class="method-args">(conn, data, args)</span>
199
+ </div>
200
+
201
+ <div class="method-description">
202
+ <p>
203
+ Alias for <a href="Server.html#M000033">set</a>
204
+ </p>
205
+ </div>
206
+ </div>
207
+
208
+ <div id="method-M000036" class="method-detail">
209
+ <a name="M000036"></a>
210
+
211
+ <div class="method-heading">
212
+ <span class="method-name">append</span><span class="method-args">(conn, data, args)</span>
213
+ </div>
214
+
215
+ <div class="method-description">
216
+ <p>
217
+ Alias for <a href="Server.html#M000033">set</a>
218
+ </p>
219
+ </div>
220
+ </div>
221
+
222
+ <div id="method-M000032" class="method-detail">
223
+ <a name="M000032"></a>
224
+
225
+ <div class="method-heading">
226
+ <a href="#M000032" class="method-signature">
227
+ <span class="method-name">close</span><span class="method-args">(conn)</span>
228
+ </a>
229
+ </div>
230
+
231
+ <div class="method-description">
232
+ <p><a class="source-toggle" href="#"
233
+ onclick="toggleCode('M000032-source');return false;">[Source]</a></p>
234
+ <div class="method-source-code" id="M000032-source">
235
+ <pre>
236
+ <span class="ruby-comment cmt"># File lib/evented_memcache_client/server.rb, line 86</span>
237
+ 86: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close</span>(<span class="ruby-identifier">conn</span>)
238
+ 87: <span class="ruby-ivar">@connections</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">conn</span>)
239
+ 88: <span class="ruby-keyword kw">end</span>
240
+ </pre>
241
+ </div>
242
+ </div>
243
+ </div>
244
+
245
+ <div id="method-M000038" class="method-detail">
246
+ <a name="M000038"></a>
247
+
248
+ <div class="method-heading">
249
+ <a href="#M000038" class="method-signature">
250
+ <span class="method-name">get</span><span class="method-args">(conn, data, args)</span>
251
+ </a>
252
+ </div>
253
+
254
+ <div class="method-description">
255
+ <p><a class="source-toggle" href="#"
256
+ onclick="toggleCode('M000038-source');return false;">[Source]</a></p>
257
+ <div class="method-source-code" id="M000038-source">
258
+ <pre>
259
+ <span class="ruby-comment cmt"># File lib/evented_memcache_client/server.rb, line 98</span>
260
+ 98: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">conn</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">args</span>)
261
+ 99: <span class="ruby-comment cmt"># we don't do nuffing</span>
262
+ 100: <span class="ruby-keyword kw">end</span>
263
+ </pre>
264
+ </div>
265
+ </div>
266
+ </div>
267
+
268
+ <div id="method-M000031" class="method-detail">
269
+ <a name="M000031"></a>
270
+
271
+ <div class="method-heading">
272
+ <a href="#M000031" class="method-signature">
273
+ <span class="method-name">open</span><span class="method-args">(conn)</span>
274
+ </a>
275
+ </div>
276
+
277
+ <div class="method-description">
278
+ <p>
279
+ Callbacks from the connection
280
+ </p>
281
+ <p><a class="source-toggle" href="#"
282
+ onclick="toggleCode('M000031-source');return false;">[Source]</a></p>
283
+ <div class="method-source-code" id="M000031-source">
284
+ <pre>
285
+ <span class="ruby-comment cmt"># File lib/evented_memcache_client/server.rb, line 82</span>
286
+ 82: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">open</span>(<span class="ruby-identifier">conn</span>)
287
+ 83: <span class="ruby-ivar">@connections</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">conn</span>
288
+ 84: <span class="ruby-keyword kw">end</span>
289
+ </pre>
290
+ </div>
291
+ </div>
292
+ </div>
293
+
294
+ <div id="method-M000035" class="method-detail">
295
+ <a name="M000035"></a>
296
+
297
+ <div class="method-heading">
298
+ <span class="method-name">prepend</span><span class="method-args">(conn, data, args)</span>
299
+ </div>
300
+
301
+ <div class="method-description">
302
+ <p>
303
+ Alias for <a href="Server.html#M000033">set</a>
304
+ </p>
305
+ </div>
306
+ </div>
307
+
308
+ <div id="method-M000034" class="method-detail">
309
+ <a name="M000034"></a>
310
+
311
+ <div class="method-heading">
312
+ <span class="method-name">replace</span><span class="method-args">(conn, data, args)</span>
313
+ </div>
314
+
315
+ <div class="method-description">
316
+ <p>
317
+ Alias for <a href="Server.html#M000033">set</a>
318
+ </p>
319
+ </div>
320
+ </div>
321
+
322
+ <div id="method-M000033" class="method-detail">
323
+ <a name="M000033"></a>
324
+
325
+ <div class="method-heading">
326
+ <a href="#M000033" class="method-signature">
327
+ <span class="method-name">set</span><span class="method-args">(conn, data, args)</span>
328
+ </a>
329
+ </div>
330
+
331
+ <div class="method-description">
332
+ <p><a class="source-toggle" href="#"
333
+ onclick="toggleCode('M000033-source');return false;">[Source]</a></p>
334
+ <div class="method-source-code" id="M000033-source">
335
+ <pre>
336
+ <span class="ruby-comment cmt"># File lib/evented_memcache_client/server.rb, line 90</span>
337
+ 90: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set</span>(<span class="ruby-identifier">conn</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">args</span>)
338
+ 91: <span class="ruby-comment cmt"># we don't do nuffing</span>
339
+ 92: <span class="ruby-keyword kw">end</span>
340
+ </pre>
341
+ </div>
342
+ </div>
343
+ </div>
344
+
345
+ <div id="method-M000029" class="method-detail">
346
+ <a name="M000029"></a>
347
+
348
+ <div class="method-heading">
349
+ <a href="#M000029" class="method-signature">
350
+ <span class="method-name">start</span><span class="method-args">()</span>
351
+ </a>
352
+ </div>
353
+
354
+ <div class="method-description">
355
+ <p>
356
+ Start listening for client connections.
357
+ </p>
358
+ <p><a class="source-toggle" href="#"
359
+ onclick="toggleCode('M000029-source');return false;">[Source]</a></p>
360
+ <div class="method-source-code" id="M000029-source">
361
+ <pre>
362
+ <span class="ruby-comment cmt"># File lib/evented_memcache_client/server.rb, line 47</span>
363
+ 47: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
364
+ 48: <span class="ruby-keyword kw">begin</span>
365
+ 49: <span class="ruby-ivar">@signature</span> = <span class="ruby-constant">EventMachine</span>.<span class="ruby-identifier">start_server</span>(<span class="ruby-ivar">@host</span>,
366
+ 50: <span class="ruby-ivar">@port</span>.<span class="ruby-identifier">to_i</span>,
367
+ 51: <span class="ruby-constant">Connectable</span>,
368
+ 52: <span class="ruby-keyword kw">self</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">conn</span><span class="ruby-operator">|</span>
369
+ 53: <span class="ruby-identifier">conn</span>.<span class="ruby-identifier">set_handler</span>(<span class="ruby-keyword kw">self</span>)
370
+ 54:
371
+ 55: <span class="ruby-comment cmt"># Usually called from EM; we fake it out.</span>
372
+ 56: <span class="ruby-identifier">conn</span>.<span class="ruby-identifier">connection_completed</span>
373
+ 57: }
374
+ 58: <span class="ruby-keyword kw">rescue</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
375
+ 59: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
376
+ 60: <span class="ruby-keyword kw">else</span>
377
+ 61: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
378
+ 62: <span class="ruby-keyword kw">end</span>
379
+ 63: <span class="ruby-keyword kw">end</span>
380
+ </pre>
381
+ </div>
382
+ </div>
383
+ </div>
384
+
385
+ <div id="method-M000030" class="method-detail">
386
+ <a name="M000030"></a>
387
+
388
+ <div class="method-heading">
389
+ <a href="#M000030" class="method-signature">
390
+ <span class="method-name">stop</span><span class="method-args">()</span>
391
+ </a>
392
+ </div>
393
+
394
+ <div class="method-description">
395
+ <p>
396
+ Stop listening for client connections, and <a
397
+ href="Server.html#M000032">close</a> any <a
398
+ href="Server.html#M000031">open</a> clients.
399
+ </p>
400
+ <p><a class="source-toggle" href="#"
401
+ onclick="toggleCode('M000030-source');return false;">[Source]</a></p>
402
+ <div class="method-source-code" id="M000030-source">
403
+ <pre>
404
+ <span class="ruby-comment cmt"># File lib/evented_memcache_client/server.rb, line 67</span>
405
+ 67: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stop</span>
406
+ 68: <span class="ruby-constant">EventMachine</span>.<span class="ruby-identifier">stop_server</span>(<span class="ruby-ivar">@signature</span>)
407
+ 69: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">wait_for_connections</span>
408
+ 70: <span class="ruby-comment cmt"># Still some running</span>
409
+ 71: <span class="ruby-constant">EventMachine</span>.<span class="ruby-identifier">add_periodic_timer</span>(<span class="ruby-value">1</span>) {
410
+ 72: <span class="ruby-identifier">wait_for_connections</span>
411
+ 73: }
412
+ 74: <span class="ruby-keyword kw">end</span>
413
+ 75: <span class="ruby-keyword kw">end</span>
414
+ </pre>
415
+ </div>
416
+ </div>
417
+ </div>
418
+
419
+ <h3 class="section-bar">Protected Instance methods</h3>
420
+
421
+ <div id="method-M000039" class="method-detail">
422
+ <a name="M000039"></a>
423
+
424
+ <div class="method-heading">
425
+ <a href="#M000039" class="method-signature">
426
+ <span class="method-name">wait_for_connections</span><span class="method-args">()</span>
427
+ </a>
428
+ </div>
429
+
430
+ <div class="method-description">
431
+ <p><a class="source-toggle" href="#"
432
+ onclick="toggleCode('M000039-source');return false;">[Source]</a></p>
433
+ <div class="method-source-code" id="M000039-source">
434
+ <pre>
435
+ <span class="ruby-comment cmt"># File lib/evented_memcache_client/server.rb, line 104</span>
436
+ 104: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">wait_for_connections</span>
437
+ 105: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@connections</span>.<span class="ruby-identifier">empty?</span>
438
+ 106: <span class="ruby-keyword kw">true</span>
439
+ 107: <span class="ruby-keyword kw">else</span>
440
+ 108: <span class="ruby-ivar">@connections</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
441
+ 109: <span class="ruby-identifier">c</span>.<span class="ruby-identifier">close_connection_after_writing</span>
442
+ 110: }
443
+ 111: <span class="ruby-keyword kw">false</span>
444
+ 112: <span class="ruby-keyword kw">end</span>
445
+ 113: <span class="ruby-keyword kw">end</span>
446
+ </pre>
447
+ </div>
448
+ </div>
449
+ </div>
450
+
451
+
452
+ </div>
453
+
454
+
455
+ </div>
456
+
457
+
458
+ <div id="validator-badges">
459
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
460
+ </div>
461
+
462
+ </body>
463
+ </html>