root/site_resources/oldapi/cherrypy.lib.filter.cachefilter.CacheFilter-class.html

Revision 1733, 16.5 kB (checked in by kevin, 2 years ago)

various resources used for building the site

Line 
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3           "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6   <title>cherrypy.lib.filter.cachefilter.CacheFilter</title>
7   <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
8 </head>
9 <body bgcolor="white" text="black" link="blue" vlink="#204080"
10       alink="#204080">
11
12 <!-- =========== START OF NAVBAR =========== -->
13 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14   <tr valign="center">
15     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
16     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
17     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
18     <th class="navbar" align="right" width="100%">
19       <table border="0" cellpadding="0" cellspacing="0">
20       <tr><th class="navbar" align="center">
21         <p class="nomargin">
22           <a class="navbar" target="_top" href="http://www.turbogears.org">TurboGears</a>
23       </p></th></tr></table>
24     </th>
25   </tr>
26 </table>
27 <table width="100%" cellpadding="0" cellspacing="0">
28   <tr valign="top">
29     <td width="100%">
30       <font size="-1"><b class="breadcrumbs">
31         <a href="cherrypy-module.html">Package&nbsp;cherrypy</a> ::
32         <a href="cherrypy.lib-module.html">Package&nbsp;lib</a> ::
33         <a href="cherrypy.lib.filter-module.html">Package&nbsp;filter</a> ::
34         <a href="cherrypy.lib.filter.cachefilter-module.html">Module&nbsp;cachefilter</a> ::
35         Class&nbsp;CacheFilter
36       </b></font></br>
37     </td>
38     <td><table cellpadding="0" cellspacing="0">
39       <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="cherrypy.lib.filter.cachefilter.CacheFilter-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
40     </table></td>
41 </tr></table>
42
43 <!-- =========== START OF CLASS DESCRIPTION =========== -->
44 <h2 class="class">Type CacheFilter</h2>
45
46 <pre class="base-tree">
47 <a href="__builtin__.object-class.html"><code>object</code></a> --+   
48          |   
49 <a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html"><code>BaseFilter</code></a> --+
50              |
51             <b>CacheFilter</b>
52 </pre><br />
53
54 <hr/>
55
56 If the page is already stored in the cache, serves the contents. If
57 the page is not in the cache, caches the output.
58 <hr/>
59
60
61 <!-- =========== START OF METHOD SUMMARY =========== -->
62 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
63 <tr bgcolor="#70b0f0" class="summary">
64   <th colspan="2">Method Summary</th></tr>
65 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
66   <td><code><span class="summary-sig"><a href="cherrypy.lib.filter.cachefilter.CacheFilter-class.html#beforeMain" class="summary-sig-name"><code>beforeMain</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
67  <a href="source/cherrypy.lib.filter.basefilter-module.html#43" class="source">[source]</a>
68 <br />
69 Called after the request body has been read/parsed</td></tr>
70 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
71   <td><code><span class="summary-sig"><a href="cherrypy.lib.filter.cachefilter.CacheFilter-class.html#onEndResource" class="summary-sig-name"><code>onEndResource</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
72  <a href="source/cherrypy.lib.filter.cachefilter-module.html#156" class="source">[source]</a>
73 <br />
74 Close &amp; fix the cache entry after content was fully written</td></tr>
75 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
76   <td><code><span class="summary-sig"><a href="cherrypy.lib.filter.cachefilter.CacheFilter-class.html#onStartResource" class="summary-sig-name"><code>onStartResource</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
77  <a href="source/cherrypy.lib.filter.basefilter-module.html#35" class="source">[source]</a>
78 <br />
79 Called before any request processing has been done</td></tr>
80 <tr bgcolor="#e8f0f8" class="group">
81   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from BaseFilter</th></tr>
82 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
83   <td><code><span class="summary-sig"><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#afterErrorResponse" class="summary-sig-name"><code>afterErrorResponse</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
84  <a href="source/cherrypy.lib.filter.basefilter-module.html#55" class="source">[source]</a>
85 <br />
86 Called after _cpOnError and finalize</td></tr>
87 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
88   <td><code><span class="summary-sig"><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#beforeErrorResponse" class="summary-sig-name"><code>beforeErrorResponse</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
89  <a href="source/cherrypy.lib.filter.basefilter-module.html#51" class="source">[source]</a>
90 <br />
91 Called before _cpOnError and/or finalizing output</td></tr>
92 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
93   <td><code><span class="summary-sig"><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#beforeFinalize" class="summary-sig-name"><code>beforeFinalize</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
94  <a href="source/cherrypy.lib.filter.basefilter-module.html#47" class="source">[source]</a>
95 <br />
96 Called before final output processing</td></tr>
97 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
98   <td><code><span class="summary-sig"><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#beforeRequestBody" class="summary-sig-name"><code>beforeRequestBody</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
99  <a href="source/cherrypy.lib.filter.basefilter-module.html#39" class="source">[source]</a>
100 <br />
101 Called after the request header has been read/parsed</td></tr>
102 <tr bgcolor="#e8f0f8" class="group">
103   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>
104 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
105   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
106 <br />
107 x.__init__(...) initializes x; see x.__class__.__doc__ for
108 signature</td></tr>
109 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
110   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
111 <br />
112 x.__delattr__('name') &lt;==&gt; del x.name</td></tr>
113 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
114   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
115 <br />
116 x.__getattribute__('name') &lt;==&gt; x.name</td></tr>
117 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
118   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
119 <br />
120 x.__hash__() &lt;==&gt; hash(x)</td></tr>
121 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
122   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>,
123           <span class=summary-sig-arg>S</span>,
124           <span class="summary-sig-vararg">...</span>)</span></code>
125 <br />
126 T.__new__(S, ...) -&gt; a new object with type S, a subtype of T</td></tr>
127 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
128   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
129 <br />
130 helper for pickle</td></tr>
131 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
132   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
133 <br />
134 helper for pickle</td></tr>
135 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
136   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
137 <br />
138 x.__repr__() &lt;==&gt; repr(x)</td></tr>
139 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
140   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
141 <br />
142 x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>
143 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
144   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
145 <br />
146 x.__str__() &lt;==&gt; str(x)</td></tr>
147 </table><br />
148
149
150 <!-- =========== START OF PROPERTY SUMMARY =========== -->
151 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
152 <tr bgcolor="#70b0f0" class="summary">
153   <th colspan="2">Property Summary</th></tr>
154 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
155   <td><b><a href="cherrypy.lib.filter.cachefilter.CacheFilter-class.html#CacheClass"><code>CacheClass</code></a></b></td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
156   <td><b><a href="cherrypy.lib.filter.cachefilter.CacheFilter-class.html#delay"><code>delay</code></a></b></td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
157   <td><b><a href="cherrypy.lib.filter.cachefilter.CacheFilter-class.html#key"><code>key</code></a></b></td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
158   <td><b><a href="cherrypy.lib.filter.cachefilter.CacheFilter-class.html#maxobjects"><code>maxobjects</code></a></b></td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
159   <td><b><a href="cherrypy.lib.filter.cachefilter.CacheFilter-class.html#maxobjsize"><code>maxobjsize</code></a></b></td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
160   <td><b><a href="cherrypy.lib.filter.cachefilter.CacheFilter-class.html#maxsize"><code>maxsize</code></a></b></td></tr></table><br />
161
162
163 <!-- =========== START OF METHOD DETAILS =========== -->
164 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
165 <tr bgcolor="#70b0f0" class="details">
166   <th colspan="2">Method Details</th></tr>
167 </table>
168
169 <a name="beforeMain"></a>
170 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
171   <h3><span class="sig"><span class="sig-name">beforeMain</span>(<span class=sig-arg>self</span>)</span>
172  <a href="source/cherrypy.lib.filter.basefilter-module.html#43" class="source">[source]</a>  </h3>
173   Called after the request body has been read/parsed
174   <dl><dt></dt><dd>
175     <dl><dt><b>Overrides:</b></dt>
176       <dd><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#beforeMain"><code>cherrypy.lib.filter.basefilter.BaseFilter.beforeMain</code></a> <i>(inherited documentation)</i>
177 </dd>
178     </dl>
179   </dd></dl>
180 </td></tr></table>
181
182 <a name="onEndResource"></a>
183 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
184   <h3><span class="sig"><span class="sig-name">onEndResource</span>(<span class=sig-arg>self</span>)</span>
185  <a href="source/cherrypy.lib.filter.cachefilter-module.html#156" class="source">[source]</a>  </h3>
186   Close &amp; fix the cache entry after content was fully written
187   <dl><dt></dt><dd>
188     <dl><dt><b>Overrides:</b></dt>
189       <dd><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#onEndResource"><code>cherrypy.lib.filter.basefilter.BaseFilter.onEndResource</code></a></dd>
190     </dl>
191   </dd></dl>
192 </td></tr></table>
193
194 <a name="onStartResource"></a>
195 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
196   <h3><span class="sig"><span class="sig-name">onStartResource</span>(<span class=sig-arg>self</span>)</span>
197  <a href="source/cherrypy.lib.filter.basefilter-module.html#35" class="source">[source]</a>  </h3>
198   Called before any request processing has been done
199   <dl><dt></dt><dd>
200     <dl><dt><b>Overrides:</b></dt>
201       <dd><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#onStartResource"><code>cherrypy.lib.filter.basefilter.BaseFilter.onStartResource</code></a> <i>(inherited documentation)</i>
202 </dd>
203     </dl>
204   </dd></dl>
205 </td></tr></table>
206 <br />
207
208
209 <!-- =========== START OF PROPERTY DETAILS =========== -->
210 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
211 <tr bgcolor="#70b0f0" class="details">
212   <th colspan="2">Property Details</th></tr>
213 </table>
214 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
215
216 <a name="CacheClass"></a>
217 <h3>CacheClass</h3>
218 <dl>
219   <dt></dt>
220   <dd>
221     <dl>
222       <dt><b>Get Method:</b></dt>
223       <dd><span class="summary-sig"><span class="summary-sig-name">unknown-2689392</span>(...)</span>
224       </dd>
225     </dl>
226   </dd>
227 </dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
228
229 <a name="delay"></a>
230 <h3>delay</h3>
231 <dl>
232   <dt></dt>
233   <dd>
234     <dl>
235       <dt><b>Get Method:</b></dt>
236       <dd><span class="summary-sig"><span class="summary-sig-name">unknown-2689520</span>(...)</span>
237       </dd>
238     </dl>
239   </dd>
240 </dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
241
242 <a name="key"></a>
243 <h3>key</h3>
244 <dl>
245   <dt></dt>
246   <dd>
247     <dl>
248       <dt><b>Get Method:</b></dt>
249       <dd><span class="summary-sig"><span class="summary-sig-name">unknown-2689456</span>(...)</span>
250       </dd>
251     </dl>
252   </dd>
253 </dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
254
255 <a name="maxobjects"></a>
256 <h3>maxobjects</h3>
257 <dl>
258   <dt></dt>
259   <dd>
260     <dl>
261       <dt><b>Get Method:</b></dt>
262       <dd><span class="summary-sig"><span class="summary-sig-name">unknown-2689712</span>(...)</span>
263       </dd>
264     </dl>
265   </dd>
266 </dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
267
268 <a name="maxobjsize"></a>
269 <h3>maxobjsize</h3>
270 <dl>
271   <dt></dt>
272   <dd>
273     <dl>
274       <dt><b>Get Method:</b></dt>
275       <dd><span class="summary-sig"><span class="summary-sig-name">unknown-2689584</span>(...)</span>
276       </dd>
277     </dl>
278   </dd>
279 </dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
280
281 <a name="maxsize"></a>
282 <h3>maxsize</h3>
283 <dl>
284   <dt></dt>
285   <dd>
286     <dl>
287       <dt><b>Get Method:</b></dt>
288       <dd><span class="summary-sig"><span class="summary-sig-name">unknown-2689648</span>(...)</span>
289       </dd>
290     </dl>
291   </dd>
292 </dl></td></tr></table><br />
293
294
295 <!-- =========== START OF NAVBAR =========== -->
296 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
297   <tr valign="center">
298     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
299     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
300     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
301     <th class="navbar" align="right" width="100%">
302       <table border="0" cellpadding="0" cellspacing="0">
303       <tr><th class="navbar" align="center">
304         <p class="nomargin">
305           <a class="navbar" target="_top" href="http://www.turbogears.org">TurboGears</a>
306       </p></th></tr></table>
307     </th>
308   </tr>
309 </table>
310
311 <table border="0" cellpadding="0" cellspacing="0" width="100%">
312   <tr>
313     <td align="left"><font size="-2">Generated by Epydoc 2.1.99 on Wed Sep 14 13:09:33 2005</font></td>
314     <td align="right"><a href="http://epydoc.sourceforge.net"
315                       ><font size="-2">http://epydoc.sf.net</font></a></td>
316   </tr>
317 </table>
318 </body>
319 </html>
Note: See TracBrowser for help on using the browser.