Documentation/Source/eric6.E5Utilities.E5Cache.html

changeset 5926
69482290dbdd
parent 5888
f23f3d2b7516
--- a/Documentation/Source/eric6.E5Utilities.E5Cache.html	Mon Oct 23 19:41:35 2017 +0200
+++ b/Documentation/Source/eric6.E5Utilities.E5Cache.html	Mon Oct 23 19:42:17 2017 +0200
@@ -70,6 +70,9 @@
 <td><a href="#E5Cache.__moveLast">__moveLast</a></td>
 <td>Private method to move a cached item to the MRU position.</td>
 </tr><tr>
+<td><a href="#E5Cache.__pruneCache">__pruneCache</a></td>
+<td>Private slot to prune outdated cache entries and restart the timer.</td>
+</tr><tr>
 <td><a href="#E5Cache.add">add</a></td>
 <td>Public method to add an item to the cache.</td>
 </tr><tr>
@@ -79,8 +82,11 @@
 <td><a href="#E5Cache.get">get</a></td>
 <td>Public method to get an entry from the cache given its key.</td>
 </tr><tr>
+<td><a href="#E5Cache.getMaximumCacheTime">getMaximumCacheTime</a></td>
+<td>Public method to get the maximum time entries may exist in the cache.</td>
+</tr><tr>
 <td><a href="#E5Cache.getSize">getSize</a></td>
-<td>Public method to get the size of the cache.</td>
+<td>Public method to get the maximum size of the cache.</td>
 </tr><tr>
 <td><a href="#E5Cache.info">info</a></td>
 <td>Public method to get some information about the cache.</td>
@@ -94,8 +100,11 @@
 <td><a href="#E5Cache.reset">reset</a></td>
 <td>Public method to reset the cache.</td>
 </tr><tr>
+<td><a href="#E5Cache.setMaximumCacheTime">setMaximumCacheTime</a></td>
+<td>Public method to set the maximum time entries may exist in the cache.</td>
+</tr><tr>
 <td><a href="#E5Cache.setSize">setSize</a></td>
-<td>Public method to change the size of the cache.</td>
+<td>Public method to change the maximum size of the cache.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
@@ -127,7 +136,12 @@
 <dd>
 key of the item to be retrieved
 </dd>
-</dl><a NAME="E5Cache.add" ID="E5Cache.add"></a>
+</dl><a NAME="E5Cache.__pruneCache" ID="E5Cache.__pruneCache"></a>
+<h4>E5Cache.__pruneCache</h4>
+<b>__pruneCache</b>(<i></i>)
+<p>
+        Private slot to prune outdated cache entries and restart the timer.
+</p><a NAME="E5Cache.add" ID="E5Cache.add"></a>
 <h4>E5Cache.add</h4>
 <b>add</b>(<i>key, item</i>)
 <p>
@@ -171,11 +185,26 @@
 <dd>
 object or None
 </dd>
+</dl><a NAME="E5Cache.getMaximumCacheTime" ID="E5Cache.getMaximumCacheTime"></a>
+<h4>E5Cache.getMaximumCacheTime</h4>
+<b>getMaximumCacheTime</b>(<i></i>)
+<p>
+        Public method to get the maximum time entries may exist in the cache.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+maximum cache time in seconds
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
 </dl><a NAME="E5Cache.getSize" ID="E5Cache.getSize"></a>
 <h4>E5Cache.getSize</h4>
 <b>getSize</b>(<i></i>)
 <p>
-        Public method to get the size of the cache.
+        Public method to get the maximum size of the cache.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
@@ -234,11 +263,21 @@
 </p><p>
         This is like clear() but sets the various counters to their initial
         value as well.
-</p><a NAME="E5Cache.setSize" ID="E5Cache.setSize"></a>
+</p><a NAME="E5Cache.setMaximumCacheTime" ID="E5Cache.setMaximumCacheTime"></a>
+<h4>E5Cache.setMaximumCacheTime</h4>
+<b>setMaximumCacheTime</b>(<i>time</i>)
+<p>
+        Public method to set the maximum time entries may exist in the cache.
+</p><dl>
+<dt><i>time</i> (int)</dt>
+<dd>
+maximum cache time in seconds
+</dd>
+</dl><a NAME="E5Cache.setSize" ID="E5Cache.setSize"></a>
 <h4>E5Cache.setSize</h4>
 <b>setSize</b>(<i>newSize</i>)
 <p>
-        Public method to change the size of the cache.
+        Public method to change the maximum size of the cache.
 </p><dl>
 <dt><i>newSize</i> (int)</dt>
 <dd>

eric ide

mercurial