cachetastic 1.2.3 → 1.2.7.1

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 (105) hide show
  1. data/README +3 -7
  2. data/bin/cachetastic_drb_server +18 -3
  3. data/lib/adapters/cachetastic_adapters_base.rb +2 -1
  4. data/lib/adapters/cachetastic_adapters_drb.rb +4 -18
  5. data/lib/adapters/cachetastic_adapters_file.rb +0 -3
  6. data/lib/adapters/cachetastic_adapters_html_file.rb +119 -0
  7. data/lib/caches/cachetastic_caches_base.rb +24 -18
  8. data/lib/caches/cachetastic_caches_mack_session_cache.rb +3 -0
  9. data/lib/cachetastic.rb +2 -0
  10. data/lib/cachetastic_logger.rb +1 -1
  11. data/lib/tasks/rubyforge_config.yml +1 -1
  12. metadata +13 -111
  13. data/doc/classes/ActiveRecord/Base.html +0 -227
  14. data/doc/classes/ActiveRecord/Base.src/M000001.html +0 -25
  15. data/doc/classes/ActiveRecord/Base.src/M000002.html +0 -18
  16. data/doc/classes/ActiveRecord/Base.src/M000003.html +0 -18
  17. data/doc/classes/ActiveRecord/Base.src/M000004.html +0 -18
  18. data/doc/classes/ActiveRecord/Base.src/M000005.html +0 -18
  19. data/doc/classes/CGI/Session/CachetasticStore.html +0 -122
  20. data/doc/classes/Cachetastic/Adapters/Base.html +0 -260
  21. data/doc/classes/Cachetastic/Adapters/Base.src/M000024.html +0 -24
  22. data/doc/classes/Cachetastic/Adapters/Base.src/M000025.html +0 -20
  23. data/doc/classes/Cachetastic/Adapters/Base.src/M000026.html +0 -21
  24. data/doc/classes/Cachetastic/Adapters/Drb.html +0 -244
  25. data/doc/classes/Cachetastic/Adapters/Drb.src/M000027.html +0 -22
  26. data/doc/classes/Cachetastic/Adapters/Drb.src/M000028.html +0 -18
  27. data/doc/classes/Cachetastic/Adapters/Drb.src/M000029.html +0 -18
  28. data/doc/classes/Cachetastic/Adapters/Drb.src/M000030.html +0 -26
  29. data/doc/classes/Cachetastic/Adapters/Drb.src/M000031.html +0 -18
  30. data/doc/classes/Cachetastic/Adapters/Drb.src/M000032.html +0 -25
  31. data/doc/classes/Cachetastic/Adapters/File.html +0 -265
  32. data/doc/classes/Cachetastic/Adapters/File.src/M000033.html +0 -18
  33. data/doc/classes/Cachetastic/Adapters/File.src/M000034.html +0 -20
  34. data/doc/classes/Cachetastic/Adapters/File.src/M000035.html +0 -19
  35. data/doc/classes/Cachetastic/Adapters/File.src/M000036.html +0 -35
  36. data/doc/classes/Cachetastic/Adapters/File.src/M000037.html +0 -21
  37. data/doc/classes/Cachetastic/Adapters/File.src/M000038.html +0 -25
  38. data/doc/classes/Cachetastic/Adapters/LocalMemory.html +0 -238
  39. data/doc/classes/Cachetastic/Adapters/LocalMemory.src/M000018.html +0 -18
  40. data/doc/classes/Cachetastic/Adapters/LocalMemory.src/M000019.html +0 -18
  41. data/doc/classes/Cachetastic/Adapters/LocalMemory.src/M000020.html +0 -18
  42. data/doc/classes/Cachetastic/Adapters/LocalMemory.src/M000021.html +0 -26
  43. data/doc/classes/Cachetastic/Adapters/LocalMemory.src/M000022.html +0 -18
  44. data/doc/classes/Cachetastic/Adapters/LocalMemory.src/M000023.html +0 -25
  45. data/doc/classes/Cachetastic/Adapters/Memcache.html +0 -335
  46. data/doc/classes/Cachetastic/Adapters/Memcache.src/M000007.html +0 -19
  47. data/doc/classes/Cachetastic/Adapters/Memcache.src/M000008.html +0 -18
  48. data/doc/classes/Cachetastic/Adapters/Memcache.src/M000009.html +0 -18
  49. data/doc/classes/Cachetastic/Adapters/Memcache.src/M000010.html +0 -18
  50. data/doc/classes/Cachetastic/Adapters/Memcache.src/M000011.html +0 -18
  51. data/doc/classes/Cachetastic/Adapters/Memcache.src/M000012.html +0 -18
  52. data/doc/classes/Cachetastic/Adapters/Memcache.src/M000013.html +0 -24
  53. data/doc/classes/Cachetastic/Adapters/Memcache.src/M000014.html +0 -19
  54. data/doc/classes/Cachetastic/Adapters/Memcache.src/M000015.html +0 -20
  55. data/doc/classes/Cachetastic/Adapters/Memcache.src/M000016.html +0 -20
  56. data/doc/classes/Cachetastic/Adapters/Memcache.src/M000017.html +0 -24
  57. data/doc/classes/Cachetastic/Caches/Base.html +0 -441
  58. data/doc/classes/Cachetastic/Caches/Base.src/M000040.html +0 -18
  59. data/doc/classes/Cachetastic/Caches/Base.src/M000041.html +0 -43
  60. data/doc/classes/Cachetastic/Caches/Base.src/M000042.html +0 -23
  61. data/doc/classes/Cachetastic/Caches/Base.src/M000043.html +0 -20
  62. data/doc/classes/Cachetastic/Caches/Base.src/M000044.html +0 -19
  63. data/doc/classes/Cachetastic/Caches/Base.src/M000045.html +0 -18
  64. data/doc/classes/Cachetastic/Caches/Base.src/M000046.html +0 -18
  65. data/doc/classes/Cachetastic/Caches/Base.src/M000047.html +0 -18
  66. data/doc/classes/Cachetastic/Caches/Base.src/M000048.html +0 -23
  67. data/doc/classes/Cachetastic/Caches/Base.src/M000049.html +0 -18
  68. data/doc/classes/Cachetastic/Caches/Base.src/M000050.html +0 -18
  69. data/doc/classes/Cachetastic/Caches/Base.src/M000051.html +0 -18
  70. data/doc/classes/Cachetastic/Caches/Base.src/M000052.html +0 -28
  71. data/doc/classes/Cachetastic/Caches/Base/RegisteredCaches.html +0 -168
  72. data/doc/classes/Cachetastic/Caches/Base/RegisteredCaches.src/M000053.html +0 -18
  73. data/doc/classes/Cachetastic/Caches/PageCache.html +0 -121
  74. data/doc/classes/Cachetastic/Caches/RailsSessionCache.html +0 -145
  75. data/doc/classes/Cachetastic/Caches/RailsSessionCache.src/M000039.html +0 -18
  76. data/doc/classes/Cachetastic/Connection.html +0 -186
  77. data/doc/classes/Cachetastic/Connection.src/M000054.html +0 -18
  78. data/doc/classes/Cachetastic/Connection.src/M000055.html +0 -24
  79. data/doc/classes/Cachetastic/Errors/UnsupportedAdapter.html +0 -137
  80. data/doc/classes/Cachetastic/Errors/UnsupportedAdapter.src/M000006.html +0 -18
  81. data/doc/classes/Cachetastic/Logger.html +0 -174
  82. data/doc/classes/Cachetastic/Logger.src/M000056.html +0 -22
  83. data/doc/created.rid +0 -1
  84. data/doc/files/init_rb.html +0 -227
  85. data/doc/files/lib/adapters/cachetastic_adapters_base_rb.html +0 -139
  86. data/doc/files/lib/adapters/cachetastic_adapters_drb_rb.html +0 -115
  87. data/doc/files/lib/adapters/cachetastic_adapters_file_rb.html +0 -121
  88. data/doc/files/lib/adapters/cachetastic_adapters_local_memory_rb.html +0 -109
  89. data/doc/files/lib/adapters/cachetastic_adapters_memcache_rb.html +0 -127
  90. data/doc/files/lib/adapters/cachetastic_adapters_store_object_rb.html +0 -101
  91. data/doc/files/lib/caches/cachetastic_caches_base_rb.html +0 -108
  92. data/doc/files/lib/caches/cachetastic_caches_page_cache_rb.html +0 -109
  93. data/doc/files/lib/caches/cachetastic_caches_rails_session_cache_rb.html +0 -107
  94. data/doc/files/lib/cachetastic_connection_rb.html +0 -107
  95. data/doc/files/lib/cachetastic_logger_rb.html +0 -107
  96. data/doc/files/lib/cachetastic_rb.html +0 -255
  97. data/doc/files/lib/errors/cachetastic_errors_unsupported_adapter_rb.html +0 -101
  98. data/doc/files/lib/helpers/cachetastic_helpers_active_record_rb.html +0 -101
  99. data/doc/files/lib/rails_extensions/cachetastic_active_record_base_rb.html +0 -101
  100. data/doc/files/lib/rails_extensions/cgi_session_cachetastic_store_rb.html +0 -109
  101. data/doc/fr_class_index.html +0 -40
  102. data/doc/fr_file_index.html +0 -43
  103. data/doc/fr_method_index.html +0 -82
  104. data/doc/index.html +0 -24
  105. data/doc/rdoc-style.css +0 -208
@@ -1,24 +0,0 @@
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>
7
- <head>
8
- <title>valid? (Cachetastic::Adapters::Memcache)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_memcache.rb, line 47</span>
14
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid?</span>
15
- <span class="ruby-keyword kw">begin</span>
16
- <span class="ruby-keyword kw">return</span> (<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">conn</span>.<span class="ruby-identifier">active?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">version</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_version</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>))
17
- <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
18
- <span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>
19
- <span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;\n&quot;</span>)
20
- <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
21
- <span class="ruby-keyword kw">end</span>
22
- <span class="ruby-keyword kw">end</span></pre>
23
- </body>
24
- </html>
@@ -1,19 +0,0 @@
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>
7
- <head>
8
- <title>namespace (Cachetastic::Adapters::Memcache)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_memcache.rb, line 61</span>
14
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">namespace</span>
15
- <span class="ruby-identifier">v</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_version</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>)
16
- <span class="ruby-keyword kw">return</span> <span class="ruby-node">&quot;#{name}.#{v}&quot;</span>
17
- <span class="ruby-keyword kw">end</span></pre>
18
- </body>
19
- </html>
@@ -1,20 +0,0 @@
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>
7
- <head>
8
- <title>ns_versions (Cachetastic::Adapters::Memcache)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_memcache.rb, line 66</span>
14
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ns_versions</span>
15
- <span class="ruby-identifier">ivar_cache</span> <span class="ruby-keyword kw">do</span>
16
- <span class="ruby-identifier">ns_conn</span> = <span class="ruby-constant">MemCache</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">servers</span>, <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">store_options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-identifier">:namespace</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:namespace_versions</span>}))
17
- <span class="ruby-keyword kw">end</span>
18
- <span class="ruby-keyword kw">end</span></pre>
19
- </body>
20
- </html>
@@ -1,20 +0,0 @@
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>
7
- <head>
8
- <title>increment_version (Cachetastic::Adapters::Memcache)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_memcache.rb, line 72</span>
14
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">increment_version</span>(<span class="ruby-identifier">name</span>)
15
- <span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>
16
- <span class="ruby-identifier">v</span> = <span class="ruby-identifier">get_version</span>(<span class="ruby-identifier">name</span>)
17
- <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ns_versions</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">v</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
18
- <span class="ruby-keyword kw">end</span></pre>
19
- </body>
20
- </html>
@@ -1,24 +0,0 @@
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>
7
- <head>
8
- <title>get_version (Cachetastic::Adapters::Memcache)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_memcache.rb, line 78</span>
14
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_version</span>(<span class="ruby-identifier">name</span>)
15
- <span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>
16
- <span class="ruby-identifier">v</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ns_versions</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">name</span>)
17
- <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">nil?</span>
18
- <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ns_versions</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">name</span>, <span class="ruby-value">1</span>)
19
- <span class="ruby-identifier">v</span> = <span class="ruby-value">1</span>
20
- <span class="ruby-keyword kw">end</span>
21
- <span class="ruby-identifier">v</span>
22
- <span class="ruby-keyword kw">end</span></pre>
23
- </body>
24
- </html>
@@ -1,441 +0,0 @@
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: Cachetastic::Caches::Base</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">Cachetastic::Caches::Base</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../../../files/lib/caches/cachetastic_caches_base_rb.html">
59
- lib/caches/cachetastic_caches_base.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
- <div id="description">
82
- <p>
83
- When creating a new &#8216;Cache&#8217; this class should be extended. Once
84
- extended you&#8216;ll only need to override just the methods that are
85
- different for your cache.
86
- </p>
87
- <pre>
88
- class MyAwesomeCache &lt; Cachetastic::Caches::Base
89
- end
90
- MyAwesomeCache.set(1, &quot;One&quot;)
91
- MyAwesomeCache.get(1) # =&gt; &quot;One&quot;
92
- MyAwesomeCache.update(1, &quot;One!!&quot;)
93
- MyAwesomeCache.get(1) # =&gt; &quot;One!!&quot;
94
- MyAwesomeCache.delete(1)
95
- MyAwesomeCache.get(1) # =&gt; nil
96
-
97
- class MyAwesomeCache &lt; Cachetastic::Caches::Base
98
- class &lt;&lt; self
99
- def get(key)
100
- super(key) do
101
- set(key, key * 10)
102
- end
103
- end
104
- end
105
- end
106
- MyAwesomeCache.set(1, &quot;One&quot;)
107
- MyAwesomeCache.get(1) # =&gt; &quot;One&quot;
108
- MyAwesomeCache.delete(1)
109
- MyAwesomeCache.get(1) # =&gt; 10
110
- </pre>
111
-
112
- </div>
113
-
114
-
115
- </div>
116
-
117
- <div id="method-list">
118
- <h3 class="section-bar">Methods</h3>
119
-
120
- <div class="name-list">
121
- <a href="#M000048">adapter</a>&nbsp;&nbsp;
122
- <a href="#M000051">adapter_supported?</a>&nbsp;&nbsp;
123
- <a href="#M000040">all_registered_caches</a>&nbsp;&nbsp;
124
- <a href="#M000047">cache_name</a>&nbsp;&nbsp;
125
- <a href="#M000052">calculate_expiry_time</a>&nbsp;&nbsp;
126
- <a href="#M000043">delete</a>&nbsp;&nbsp;
127
- <a href="#M000044">expire_all</a>&nbsp;&nbsp;
128
- <a href="#M000041">get</a>&nbsp;&nbsp;
129
- <a href="#M000049">logger</a>&nbsp;&nbsp;
130
- <a href="#M000045">populate_all</a>&nbsp;&nbsp;
131
- <a href="#M000042">set</a>&nbsp;&nbsp;
132
- <a href="#M000046">stats</a>&nbsp;&nbsp;
133
- <a href="#M000050">unsupported_adapters</a>&nbsp;&nbsp;
134
- </div>
135
- </div>
136
-
137
- </div>
138
-
139
-
140
- <!-- if includes -->
141
-
142
- <div id="section">
143
-
144
- <div id="class-list">
145
- <h3 class="section-bar">Classes and Modules</h3>
146
-
147
- Class <a href="Base/RegisteredCaches.html" class="link">Cachetastic::Caches::Base::RegisteredCaches</a><br />
148
-
149
- </div>
150
-
151
-
152
- <div id="aliases-list">
153
- <h3 class="section-bar">External Aliases</h3>
154
-
155
- <div class="name-list">
156
- <table summary="aliases">
157
- <tr class="top-aligned-row context-row">
158
- <td class="context-item-name">set</td>
159
- <td>-&gt;</td>
160
- <td class="context-item-value">put</td>
161
- </tr>
162
- </table>
163
- </div>
164
- </div>
165
-
166
-
167
-
168
-
169
-
170
- <!-- if method_list -->
171
- <div id="methods">
172
- <h3 class="section-bar">Public Class methods</h3>
173
-
174
- <div id="method-M000048" class="method-detail">
175
- <a name="M000048"></a>
176
-
177
- <div class="method-heading">
178
- <a href="Base.src/M000048.html" target="Code" class="method-signature"
179
- onclick="popupCode('Base.src/M000048.html');return false;">
180
- <span class="method-name">adapter</span><span class="method-args">()</span>
181
- </a>
182
- </div>
183
-
184
- <div class="method-description">
185
- <p>
186
- Returns the underlying <a
187
- href="../Adapters/Base.html">Cachetastic::Adapters::Base</a> for this
188
- cache.
189
- </p>
190
- </div>
191
- </div>
192
-
193
- <div id="method-M000051" class="method-detail">
194
- <a name="M000051"></a>
195
-
196
- <div class="method-heading">
197
- <a href="Base.src/M000051.html" target="Code" class="method-signature"
198
- onclick="popupCode('Base.src/M000051.html');return false;">
199
- <span class="method-name">adapter_supported?</span><span class="method-args">(a = cache_conn_instance.get(cache_name).class)</span>
200
- </a>
201
- </div>
202
-
203
- <div class="method-description">
204
- <p>
205
- Returns true/false on whether the <a href="Base.html#M000048">adapter</a>
206
- you want to use is supported for the cache.
207
- </p>
208
- </div>
209
- </div>
210
-
211
- <div id="method-M000040" class="method-detail">
212
- <a name="M000040"></a>
213
-
214
- <div class="method-heading">
215
- <a href="Base.src/M000040.html" target="Code" class="method-signature"
216
- onclick="popupCode('Base.src/M000040.html');return false;">
217
- <span class="method-name">all_registered_caches</span><span class="method-args">()</span>
218
- </a>
219
- </div>
220
-
221
- <div class="method-description">
222
- <p>
223
- Returns a list of all registered caches in the system.
224
- </p>
225
- </div>
226
- </div>
227
-
228
- <div id="method-M000047" class="method-detail">
229
- <a name="M000047"></a>
230
-
231
- <div class="method-heading">
232
- <a href="Base.src/M000047.html" target="Code" class="method-signature"
233
- onclick="popupCode('Base.src/M000047.html');return false;">
234
- <span class="method-name">cache_name</span><span class="method-args">()</span>
235
- </a>
236
- </div>
237
-
238
- <div class="method-description">
239
- <p>
240
- Returns a &#8216;methodize&#8217; version of the cache&#8216;s class name.
241
- This gets used in logging, namespacing, and as the key in the <a
242
- href="../Connection.html">Cachetastic::Connection</a> class.
243
- </p>
244
- <pre>
245
- MyAwesomeCache.cache # =&gt; &quot;my_awesome_cache&quot;
246
- Cachetastic::Caches::Base # =&gt; &quot;cachetastic_caches_base&quot;
247
- </pre>
248
- </div>
249
- </div>
250
-
251
- <div id="method-M000043" class="method-detail">
252
- <a name="M000043"></a>
253
-
254
- <div class="method-heading">
255
- <a href="Base.src/M000043.html" target="Code" class="method-signature"
256
- onclick="popupCode('Base.src/M000043.html');return false;">
257
- <span class="method-name">delete</span><span class="method-args">(key, delay = 0)</span>
258
- </a>
259
- </div>
260
-
261
- <div class="method-description">
262
- <p>
263
- Deletes an object from the cache. The optional delay parameter sets an
264
- offset, in seconds, for when the object should <a
265
- href="Base.html#M000041">get</a> deleted. The default of 0 means the object
266
- gets deleted right away.
267
- </p>
268
- </div>
269
- </div>
270
-
271
- <div id="method-M000044" class="method-detail">
272
- <a name="M000044"></a>
273
-
274
- <div class="method-heading">
275
- <a href="Base.src/M000044.html" target="Code" class="method-signature"
276
- onclick="popupCode('Base.src/M000044.html');return false;">
277
- <span class="method-name">expire_all</span><span class="method-args">()</span>
278
- </a>
279
- </div>
280
-
281
- <div class="method-description">
282
- <p>
283
- Expires all objects for this cache.
284
- </p>
285
- </div>
286
- </div>
287
-
288
- <div id="method-M000041" class="method-detail">
289
- <a name="M000041"></a>
290
-
291
- <div class="method-heading">
292
- <a href="Base.src/M000041.html" target="Code" class="method-signature"
293
- onclick="popupCode('Base.src/M000041.html');return false;">
294
- <span class="method-name">get</span><span class="method-args">(key) {|key if block_given?| ...}</span>
295
- </a>
296
- </div>
297
-
298
- <div class="method-description">
299
- <p>
300
- Returns an object from the cache for a given key. If the object comes back
301
- as nil and a block is given that block will be run and the results of the
302
- block will be run. This can be used to JIT caches, just make sure in the
303
- block to call the <a href="Base.html#M000042">set</a> method because the
304
- results of the block are not automatically cached.
305
- </p>
306
- </div>
307
- </div>
308
-
309
- <div id="method-M000049" class="method-detail">
310
- <a name="M000049"></a>
311
-
312
- <div class="method-heading">
313
- <a href="Base.src/M000049.html" target="Code" class="method-signature"
314
- onclick="popupCode('Base.src/M000049.html');return false;">
315
- <span class="method-name">logger</span><span class="method-args">()</span>
316
- </a>
317
- </div>
318
-
319
- <div class="method-description">
320
- <p>
321
- Returns the <a href="../Logger.html">Cachetastic::Logger</a> for the
322
- underlying <a href="../Adapters/Base.html">Cachetastic::Adapters::Base</a>.
323
- </p>
324
- </div>
325
- </div>
326
-
327
- <div id="method-M000045" class="method-detail">
328
- <a name="M000045"></a>
329
-
330
- <div class="method-heading">
331
- <a href="Base.src/M000045.html" target="Code" class="method-signature"
332
- onclick="popupCode('Base.src/M000045.html');return false;">
333
- <span class="method-name">populate_all</span><span class="method-args">()</span>
334
- </a>
335
- </div>
336
-
337
- <div class="method-description">
338
- <p>
339
- Raises a MethodNotImplemented exception. This method should be overridden
340
- in the child class to enable a populating the cache with all things that
341
- should be in there.
342
- </p>
343
- </div>
344
- </div>
345
-
346
- <div id="method-M000042" class="method-detail">
347
- <a name="M000042"></a>
348
-
349
- <div class="method-heading">
350
- <a href="Base.src/M000042.html" target="Code" class="method-signature"
351
- onclick="popupCode('Base.src/M000042.html');return false;">
352
- <span class="method-name">set</span><span class="method-args">(key, value, expiry = (adapter.all_options[&quot;default_expiry&quot;] || 0))</span>
353
- </a>
354
- </div>
355
-
356
- <div class="method-description">
357
- <p>
358
- Set a particular object info the cache for the given key. An optional third
359
- parameter sets the expiry time for the object in the cache. The default for
360
- this expiry is <a href="Base.html#M000042">set</a> as either 0, meaning it
361
- never expires, or if there&#8216;s a default_expiry time <a
362
- href="Base.html#M000042">set</a> in the config file, that file will be
363
- used. If there is an expiry_swing <a href="Base.html#M000042">set</a> in
364
- the config file it will be +/- to the expiry time. See also: <a
365
- href="Base.html#M000052">calculate_expiry_time</a>
366
- </p>
367
- </div>
368
- </div>
369
-
370
- <div id="method-M000046" class="method-detail">
371
- <a name="M000046"></a>
372
-
373
- <div class="method-heading">
374
- <a href="Base.src/M000046.html" target="Code" class="method-signature"
375
- onclick="popupCode('Base.src/M000046.html');return false;">
376
- <span class="method-name">stats</span><span class="method-args">()</span>
377
- </a>
378
- </div>
379
-
380
- <div class="method-description">
381
- <p>
382
- A convenience method that returns statistics for the underlying <a
383
- href="../Adapters/Base.html">Cachetastic::Adapters::Base</a> for the cache.
384
- </p>
385
- </div>
386
- </div>
387
-
388
- <div id="method-M000050" class="method-detail">
389
- <a name="M000050"></a>
390
-
391
- <div class="method-heading">
392
- <a href="Base.src/M000050.html" target="Code" class="method-signature"
393
- onclick="popupCode('Base.src/M000050.html');return false;">
394
- <span class="method-name">unsupported_adapters</span><span class="method-args">()</span>
395
- </a>
396
- </div>
397
-
398
- <div class="method-description">
399
- <p>
400
- Returns an array of unsupported adapters for this cache. Defaults to an
401
- empty array which will let any <a href="Base.html#M000048">adapter</a> be
402
- used by the cache. Override in your specific cache to prevent certain
403
- adapters.
404
- </p>
405
- </div>
406
- </div>
407
-
408
- <h3 class="section-bar">Private Class methods</h3>
409
-
410
- <div id="method-M000052" class="method-detail">
411
- <a name="M000052"></a>
412
-
413
- <div class="method-heading">
414
- <a href="Base.src/M000052.html" target="Code" class="method-signature"
415
- onclick="popupCode('Base.src/M000052.html');return false;">
416
- <span class="method-name">calculate_expiry_time</span><span class="method-args">(expiry)</span>
417
- </a>
418
- </div>
419
-
420
- <div class="method-description">
421
- <p>
422
- If the expiry time is <a href="Base.html#M000042">set</a> to 60 minutes and
423
- the expiry_swing time is <a href="Base.html#M000042">set</a> to 15 minutes,
424
- this method will return a number between 45 minutes and 75 minutes.
425
- </p>
426
- </div>
427
- </div>
428
-
429
-
430
- </div>
431
-
432
-
433
- </div>
434
-
435
-
436
- <div id="validator-badges">
437
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
438
- </div>
439
-
440
- </body>
441
- </html>