unicache 0.0.2 → 0.0.3

data/doc/UniCache.html

@@ -96,7 +96,9 @@
   
   
     <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/unicache.rb</dd>
+    <dd class="r2 last">lib/unicache.rb<span class="defines">,<br />
+  lib/version.rb</span>
+</dd>
   
 </dl>
 <div class="clear"></div>
@@ -104,15 +106,17 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>UniCache is Universal purpose Cache with Least Recently Used replacement
+<p><span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> is Universal purpose Cache with Least Recently Used replacement
 policy by default. Cache can be configured with another policy.</p>
 
-<p>UniCache is intended to be Thread safe.</p>
+<p><span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> is intended to be Thread safe.</p>
 
-<p>User can register callbacks that are run at various UniCache events.
+<p>User can register callbacks that are run at various <span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> events.
 ":getdata" callback is used to retreive cache data if not in cache. Others
 do not effect the UniCache state.</p>
 
+<p>UniCache is inherits Hash, i.e. almost all Hash methods are usable.</p>
+
 <p>Usage example:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>unicache</span><span class='tstring_end'>'</span></span>
@@ -161,6 +165,18 @@ Miss:  2:&lt;NA&gt;</code></pre>
   
 </p>
 
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.0.3</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      
+    </dl>
+  
+
 
 
 
@@ -231,6 +247,37 @@ Miss:  2:&lt;NA&gt;</code></pre>
 
 
   
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#version-class_method" title="version (class method)">+ (Object) <strong>version</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
     <h2>
       Instance Method Summary
       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
@@ -256,7 +303,7 @@ Miss:  2:&lt;NA&gt;</code></pre>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Get operator.</p>
+<p>Get operator (See: <span class='object_link'><a href="#get-instance_method" title="UniCache#get (method)">#get</a></span>).</p>
 </div></span>
   
 </li>
@@ -280,7 +327,7 @@ Miss:  2:&lt;NA&gt;</code></pre>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Put operator.</p>
+<p>Put operator (See: <span class='object_link'><a href="#put-instance_method" title="UniCache#put (method)">#put</a></span>).</p>
 </div></span>
   
 </li>
@@ -307,6 +354,30 @@ Miss:  2:&lt;NA&gt;</code></pre>
 <p>Clear all Cache entries.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#close-instance_method" title="#close (instance method)">- (Object) <strong>close</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Close <span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> access.</p>
+</div></span>
+  
 </li>
 
       
@@ -447,6 +518,30 @@ Miss:  2:&lt;NA&gt;</code></pre>
 <p>Cache initialization.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#open-instance_method" title="#open (instance method)">- (Object) <strong>open</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Open <span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> for access.</p>
+</div></span>
+  
 </li>
 
       
@@ -573,7 +668,7 @@ Miss:  2:&lt;NA&gt;</code></pre>
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#resize-instance_method" title="#resize (instance method)">- (Object) <strong>resize</strong>(size) </a>
+      <a href="#resize-instance_method" title="#resize (instance method)">- (Integer) <strong>resize</strong>(size) </a>
     
 
     
@@ -681,7 +776,7 @@ Miss:  2:&lt;NA&gt;</code></pre>
       
         &mdash;
         <div class='inline'>
-<p>Cache size.</p>
+<p>Cache size (&gt; 0), nil for infinite size.</p>
 </div>
       
     </li>
@@ -713,8 +808,6 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="lines">
 
 
-72
-73
 74
 75
 76
@@ -726,10 +819,12 @@ Miss:  2:&lt;NA&gt;</code></pre>
 82
 83
 84
-85</pre>
+85
+86
+87</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 72</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 74</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_size'>size</span><span class='comma'>,</span> <span class='id identifier rubyid_evict'>evict</span> <span class='op'>=</span> <span class='const'>LruEviction</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='rparen'>)</span>
     <span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span>
@@ -740,7 +835,7 @@ Miss:  2:&lt;NA&gt;</code></pre>
 
     <span class='id identifier rubyid_setEviction'>setEviction</span><span class='lparen'>(</span> <span class='id identifier rubyid_evict'>evict</span> <span class='rparen'>)</span>
 
-    <span class='ivar'>@cb</span> <span class='op'>=</span> <span class='const'>NotifyHub</span><span class='period'>.</span><span class='id identifier rubyid_declare'>declare</span><span class='lparen'>(</span> <span class='symbol'>:getdata</span><span class='comma'>,</span>
+    <span class='ivar'>@cb</span> <span class='op'>=</span> <span class='const'>NotifyHub</span><span class='period'>.</span><span class='id identifier rubyid_declare'>declare</span><span class='lparen'>(</span> <span class='symbol'>:open</span><span class='comma'>,</span> <span class='symbol'>:close</span><span class='comma'>,</span> <span class='symbol'>:getdata</span><span class='comma'>,</span>
                              <span class='symbol'>:add</span><span class='comma'>,</span> <span class='symbol'>:replace</span><span class='comma'>,</span> <span class='symbol'>:put</span><span class='comma'>,</span> <span class='symbol'>:overwrite</span><span class='comma'>,</span>
                              <span class='symbol'>:remove</span><span class='comma'>,</span> <span class='symbol'>:valueremove</span><span class='comma'>,</span> <span class='symbol'>:hit</span><span class='comma'>,</span> <span class='symbol'>:miss</span><span class='comma'>,</span>
                              <span class='symbol'>:peek</span> <span class='rparen'>)</span>
@@ -783,12 +878,12 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="lines">
 
 
-65
-66
-67</pre>
+67
+68
+69</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 65</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 67</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_lock'>lock</span>
   <span class='ivar'>@lock</span>
@@ -826,12 +921,12 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="lines">
 
 
-62
-63
-64</pre>
+64
+65
+66</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 62</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 64</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
   <span class='ivar'>@size</span>
@@ -844,6 +939,42 @@ Miss:  2:&lt;NA&gt;</code></pre>
   </div>
 
 
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="version-class_method">
+  
+    + (<tt>Object</tt>) <strong>version</strong> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+3
+4
+5</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/version.rb', line 3</span>
+
+<span class='kw'>def</span> <span class='const'>UniCache</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span>
+    <span class='const'>VERSION</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
   <div id="instance_method_details" class="method_details_list">
     <h2>Instance Method Details</h2>
 
@@ -860,7 +991,7 @@ Miss:  2:&lt;NA&gt;</code></pre>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Get operator.</p>
+<p>Get operator (See: <span class='object_link'><a href="#get-instance_method" title="UniCache#get (method)">#get</a></span>)</p>
 
 
   </div>
@@ -874,12 +1005,12 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="lines">
 
 
-158
-159
-160</pre>
+177
+178
+179</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 158</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 177</span>
 
 <span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
     <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
@@ -901,7 +1032,7 @@ Miss:  2:&lt;NA&gt;</code></pre>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Put operator.</p>
+<p>Put operator (See: <span class='object_link'><a href="#put-instance_method" title="UniCache#put (method)">#put</a></span>)</p>
 
 
   </div>
@@ -915,12 +1046,12 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="lines">
 
 
-133
-134
-135</pre>
+152
+153
+154</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 133</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 152</span>
 
 <span class='kw'>def</span> <span class='op'>[]=</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='rparen'>)</span>
     <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='rparen'>)</span>
@@ -956,17 +1087,17 @@ Miss:  2:&lt;NA&gt;</code></pre>
       <pre class="lines">
 
 
-283
-284
-285
-286
-287
-288
-289
-290</pre>
+316
+317
+318
+319
+320
+321
+322
+323</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 283</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 316</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_clear'>clear</span>
     <span class='ivar'>@lock</span><span class='period'>.</span><span class='id identifier rubyid_lock'>lock</span>
@@ -979,6 +1110,48 @@ Miss:  2:&lt;NA&gt;</code></pre>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="close-instance_method">
+  
+    - (<tt>Object</tt>) <strong>close</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Close <span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> access. The ":close" callback is executed. Typically the
+user would perform <span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> content store with the callback.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+126
+127
+128</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 126</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_close'>close</span>
+    <span class='id identifier rubyid_runCallbacks'>runCallbacks</span><span class='lparen'>(</span> <span class='symbol'>:close</span><span class='comma'>,</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -993,8 +1166,8 @@ Miss:  2:&lt;NA&gt;</code></pre>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Get Cache entry existance by key (no effect to eviction). Uses "peek", i.e.
-peek CB is run.</p>
+<p>Get Cache entry existance by key (no effect to eviction). Uses
+<span class='object_link'><a href="#peek-instance_method" title="UniCache#peek (method)">#peek</a></span>, i.e. peek CB is run.</p>
 
 
   </div>
@@ -1041,16 +1214,16 @@ peek CB is run.</p>
       <pre class="lines">
 
 
-176
-177
-178
-179
-180
-181
-182</pre>
+195
+196
+197
+198
+199
+200
+201</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 176</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 195</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_exist?'>exist?</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
     <span class='kw'>if</span> <span class='id identifier rubyid_peek'>peek</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
@@ -1078,11 +1251,11 @@ peek CB is run.</p>
     
 <p>Get Cache entry by key or return nil if not in Cache.</p>
 
-<p>If block is provided, it is run under UniCache lock and will protect the
+<p>If block is provided, it is run under <span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> lock and will protect the
 used data from being removed (concurrently).</p>
 
 <p>If ":getdata" callback is defined, it is used to get data. Data is always
-used, also when nil. UniCache lock is released before callback is called.</p>
+used, also when nil. <span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> lock is released before callback is called.</p>
 
 
   </div>
@@ -1121,7 +1294,7 @@ used, also when nil. UniCache lock is released before callback is called.</p>
       
         
         <div class='inline'>
-<p>Procedure to fetch the data.</p>
+<p>Procedure to run with the data.</p>
 </div>
       
     </li>
@@ -1134,21 +1307,21 @@ used, also when nil. UniCache lock is released before callback is called.</p>
       <pre class="lines">
 
 
-149
-150
-151
-152
-153
-154</pre>
+168
+169
+170
+171
+172
+173</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 149</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 168</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_blk'>blk</span> <span class='rparen'>)</span>
     <span class='ivar'>@lock</span><span class='period'>.</span><span class='id identifier rubyid_lock'>lock</span>
     <span class='id identifier rubyid_ret'>ret</span> <span class='op'>=</span> <span class='id identifier rubyid__get'>_get</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_blk'>blk</span> <span class='rparen'>)</span>
     <span class='ivar'>@lock</span><span class='period'>.</span><span class='id identifier rubyid_unlock'>unlock</span>
-    <span class='id identifier rubyid_ret'>ret</span> 
+    <span class='id identifier rubyid_ret'>ret</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1170,10 +1343,10 @@ used, also when nil. UniCache lock is released before callback is called.</p>
       <pre class="lines">
 
 
-97</pre>
+99</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 97</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 99</span>
 
 <span class='kw'>alias</span> <span class='symbol'>:hash_get_op</span> <span class='symbol'>:[]</span></pre>
     </td>
@@ -1196,10 +1369,10 @@ used, also when nil. UniCache lock is released before callback is called.</p>
       <pre class="lines">
 
 
-96</pre>
+98</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 96</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 98</span>
 
 <span class='kw'>alias</span> <span class='symbol'>:hash_set_op</span> <span class='symbol'>:[]=</span></pre>
     </td>
@@ -1222,15 +1395,57 @@ used, also when nil. UniCache lock is released before callback is called.</p>
       <pre class="lines">
 
 
-99</pre>
+101</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 99</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 101</span>
 
 <span class='kw'>alias</span> <span class='symbol'>:hash_store</span> <span class='symbol'>:store</span></pre>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="open-instance_method">
+  
+    - (<tt>Object</tt>) <strong>open</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Open <span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> for access. The ":open" callback is executed. Typically the
+user would perform <span class='object_link'><a href="" title="UniCache (class)">UniCache</a></span> content initialization with the callback.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+118
+119
+120</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 118</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_open'>open</span>
+    <span class='id identifier rubyid_runCallbacks'>runCallbacks</span><span class='lparen'>(</span> <span class='symbol'>:open</span><span class='comma'>,</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -1279,13 +1494,13 @@ used, also when nil. UniCache lock is released before callback is called.</p>
       <pre class="lines">
 
 
-166
-167
-168
-169</pre>
+185
+186
+187
+188</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 166</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 185</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_peek'>peek</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
     <span class='id identifier rubyid_runCallbacks'>runCallbacks</span><span class='lparen'>(</span> <span class='symbol'>:peek</span><span class='comma'>,</span> <span class='id identifier rubyid_key'>key</span> <span class='rparen'>)</span>
@@ -1358,21 +1573,21 @@ used, also when nil. UniCache lock is released before callback is called.</p>
       <pre class="lines">
 
 
-124
-125
-126
-127
-128
-129</pre>
+143
+144
+145
+146
+147
+148</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 124</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 143</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='rparen'>)</span>
     <span class='ivar'>@lock</span><span class='period'>.</span><span class='id identifier rubyid_lock'>lock</span>
     <span class='id identifier rubyid_ret'>ret</span> <span class='op'>=</span> <span class='id identifier rubyid__put'>_put</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='rparen'>)</span>
     <span class='ivar'>@lock</span><span class='period'>.</span><span class='id identifier rubyid_unlock'>unlock</span>
-    <span class='id identifier rubyid_ret'>ret</span> 
+    <span class='id identifier rubyid_ret'>ret</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1391,52 +1606,62 @@ used, also when nil. UniCache lock is released before callback is called.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Register a callback to be executed on Cache event.</p>
+<p>Register a callback to be executed on Cache event. Callbacks are passed
+with following arguments: CacheKey, CacheValue, CacheObject.</p>
 
 <p>Possible events:</p>
-<dl class="rdoc-list"><dt>getdata</dt>
+<dl class="rdoc-list"><dt>:open</dt>
+<dd>
+<p>Called when <span class='object_link'><a href="#open-instance_method" title="UniCache#open (method)">#open</a></span> is executed. This is typically used to
+initialize the UniCache content.</p>
+</dd><dt>:close</dt>
+<dd>
+<p>Called when <span class='object_link'><a href="#close-instance_method" title="UniCache#close (method)">#close</a></span> is executed. This is typically used to store
+the UniCache content for next session.</p>
+</dd><dt>:getdata</dt>
 <dd>
 <p>Data not found in cache, callback is used to fetch it. Data is always added
 to cache unless an exception is raised. Also all retrys should be captured
 into ":getdata". &lt;key,value&gt; from request.</p>
-</dd><dt>add</dt>
+</dd><dt>:add</dt>
 <dd>
 <p>Item is added to Cache without anything being replaced. &lt;key,value&gt;
 from request.</p>
-</dd><dt>replace</dt>
+</dd><dt>:replace</dt>
 <dd>
 <p>Item is added to Cache and another item is removed. &lt;key,value&gt; is
 evicted entry.</p>
-</dd><dt>put</dt>
+</dd><dt>:put</dt>
 <dd>
 <p>Item is added to Cache. Cache conditions has no effect i.e. always run for
 "put". &lt;key,value&gt; from request.</p>
-</dd><dt>overwrite</dt>
+</dd><dt>:overwrite</dt>
 <dd>
 <p>Existing entry value is replaced by new item value. &lt;key,value&gt; from
 request.</p>
-</dd><dt>remove</dt>
+</dd><dt>:remove</dt>
 <dd>
 <p>Entry is deleted from Cache.</p>
-</dd><dt>valueremove</dt>
+</dd><dt>:valueremove</dt>
 <dd>
 <p>Entry value is removed (remove or overwrite). &lt;key,value&gt; from old
 entry.</p>
-</dd><dt>hit</dt>
+</dd><dt>:hit</dt>
 <dd>
 <p>Entry is found in Cache. &lt;key,value&gt; from cache.</p>
-</dd><dt>miss</dt>
+</dd><dt>:miss</dt>
 <dd>
 <p>Entry is not found in Cache. &lt;key&gt; from request.</p>
-</dd><dt>peek</dt>
+</dd><dt>:peek</dt>
 <dd>
 <p>Cache peek. &lt;key,value&gt; from request.</p>
 </dd></dl>
 
 <p>Example:</p>
 
-<pre class="code ruby"><code class="ruby">registerCallback( :add,
-  Proc.new do |k,v,o| puts &quot;Key: #{k} with value #{v} added&quot; end</code></pre>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_registerCallback'>registerCallback</span><span class='lparen'>(</span> <span class='symbol'>:add</span><span class='comma'>,</span>
+  <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='comma'>,</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span> <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Key: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_k'>k</span><span class='rbrace'>}</span><span class='tstring_content'> with value </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_v'>v</span><span class='rbrace'>}</span><span class='tstring_content'> added</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>end</span>
+<span class='rparen'>)</span></code></pre>
 
 
   </div>
@@ -1486,16 +1711,16 @@ entry.</p>
       <pre class="lines">
 
 
-259
-260
-261
-262
-263
-264
-265</pre>
+292
+293
+294
+295
+296
+297
+298</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 259</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 292</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_registerCallback'>registerCallback</span><span class='lparen'>(</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_proc'>proc</span> <span class='rparen'>)</span>
     <span class='kw'>begin</span>
@@ -1575,15 +1800,15 @@ entry.</p>
       <pre class="lines">
 
 
-189
-190
-191
-192
-193
-194</pre>
+208
+209
+210
+211
+212
+213</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 189</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 208</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_remove'>remove</span><span class='lparen'>(</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
     <span class='ivar'>@lock</span><span class='period'>.</span><span class='id identifier rubyid_lock'>lock</span>
@@ -1644,18 +1869,18 @@ entry.</p>
       <pre class="lines">
 
 
-271
-272
-273
-274
-275
-276
-277
-278
-279</pre>
+304
+305
+306
+307
+308
+309
+310
+311
+312</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 271</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 304</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_removeCallback'>removeCallback</span><span class='lparen'>(</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
     <span class='kw'>if</span> <span class='id identifier rubyid_type'>type</span>
@@ -1674,7 +1899,7 @@ entry.</p>
       <div class="method_details ">
   <h3 class="signature " id="resize-instance_method">
   
-    - (<tt>Object</tt>) <strong>resize</strong>(size) 
+    - (<tt>Integer</tt>) <strong>resize</strong>(size) 
   
 
   
@@ -1703,13 +1928,31 @@ entry.</p>
       
         &mdash;
         <div class='inline'>
-<p>New Cache size.</p>
+<p>New Cache size, “&gt; 0” or “nil”.</p>
 </div>
       
     </li>
   
 </ul>
 
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Integer</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>New Cache size.</p>
+</div>
+      
+    </li>
+  
+</ul>
 <p class="tag_title">Raises:</p>
 <ul class="raise">
   
@@ -1730,31 +1973,35 @@ entry.</p>
       <pre class="lines">
 
 
-200
-201
-202
-203
-204
-205
-206
-207
-208
-209
-210
-211
-212
-213
-214
-215
-216
-217
-218</pre>
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
+233
+234
+235
+236
+237
+238
+239
+240</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 200</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 220</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_resize'>resize</span><span class='lparen'>(</span> <span class='id identifier rubyid_size'>size</span> <span class='rparen'>)</span>
-    
+
+    <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_size'>size</span> <span class='op'>==</span> <span class='kw'>nil</span>
+
     <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SizeError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>UniCache: Size must be bigger than 0</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_size'>size</span> <span class='op'>&gt;</span> <span class='int'>0</span>
 
     <span class='ivar'>@lock</span><span class='period'>.</span><span class='id identifier rubyid_lock'>lock</span>
@@ -1823,12 +2070,12 @@ entry.</p>
       <pre class="lines">
 
 
-91
-92
-93</pre>
+93
+94
+95</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 91</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 93</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_setEviction'>setEviction</span><span class='lparen'>(</span> <span class='id identifier rubyid_evict'>evict</span> <span class='rparen'>)</span>
     <span class='ivar'>@evict</span> <span class='op'>=</span> <span class='id identifier rubyid_evict'>evict</span>
@@ -1864,10 +2111,10 @@ entry.</p>
       <pre class="lines">
 
 
-113</pre>
+132</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 113</span>
+      <pre class="code"><span class="info file"># File 'lib/unicache.rb', line 132</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
     </td>
@@ -1880,7 +2127,7 @@ entry.</p>
 </div>
 
     <div id="footer">
-  Generated on Mon Feb 10 23:59:39 2014 by
+  Generated on Thu Jul 17 14:54:03 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-1.9.3).
 </div>