|
1 <?xml version="1.0" encoding="ascii"?> |
|
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>ccm.extra.CachedSessionProvider</title> |
|
7 <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
|
8 <script type="text/javascript" src="epydoc.js"></script> |
|
9 </head> |
|
10 |
|
11 <body bgcolor="white" text="black" link="blue" vlink="#204080" |
|
12 alink="#204080"> |
|
13 <!-- ==================== NAVIGATION BAR ==================== --> |
|
14 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
15 bgcolor="#a0c0ff" cellspacing="0"> |
|
16 <tr valign="middle"> |
|
17 |
|
18 <!-- Tree link --> |
|
19 <th> <a |
|
20 href="module-tree.html">Trees</a> </th> |
|
21 |
|
22 <!-- Index link --> |
|
23 <th> <a |
|
24 href="identifier-index.html">Indices</a> </th> |
|
25 |
|
26 <!-- Help link --> |
|
27 <th> <a |
|
28 href="help.html">Help</a> </th> |
|
29 |
|
30 <th class="navbar" width="100%"></th> |
|
31 </tr> |
|
32 </table> |
|
33 <table width="100%" cellpadding="0" cellspacing="0"> |
|
34 <tr valign="top"> |
|
35 <td width="100%"> |
|
36 <span class="breadcrumbs"> |
|
37 <a href="ccm-module.html">Package ccm</a> :: |
|
38 <a href="ccm.extra-module.html">Module extra</a> :: |
|
39 Class CachedSessionProvider |
|
40 </span> |
|
41 </td> |
|
42 <td> |
|
43 <table cellpadding="0" cellspacing="0"> |
|
44 <!-- hide/show private --> |
|
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
46 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
47 <tr><td align="right"><span class="options" |
|
48 >[<a href="frames.html" target="_top">frames</a |
|
49 >] | <a href="ccm.extra.CachedSessionProvider-class.html" |
|
50 target="_top">no frames</a>]</span></td></tr> |
|
51 </table> |
|
52 </td> |
|
53 </tr> |
|
54 </table> |
|
55 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
56 <h1 class="epydoc">Class CachedSessionProvider</h1><span class="codelink"><a href="ccm.extra-pysrc.html#CachedSessionProvider">source code</a></span><br /><br /> |
|
57 <pre class="base-tree"> |
|
58 <a href="ccm.extra.SessionProvider-class.html">SessionProvider</a> --+ |
|
59 | |
|
60 <strong class="uidshort">CachedSessionProvider</strong> |
|
61 </pre> |
|
62 |
|
63 <hr /> |
|
64 <dl class="rst-docutils"> |
|
65 <dt><sessions></dt> |
|
66 <dd><session database="foobar" ccmaddr="xxxx"/> |
|
67 <session database="foobarx" ccmaddr="xxxx"/></dd> |
|
68 </dl> |
|
69 <p></sessions></p><br /><br /> |
|
70 |
|
71 <!-- ==================== INSTANCE METHODS ==================== --> |
|
72 <a name="section-InstanceMethods"></a> |
|
73 <table class="summary" border="1" cellpadding="3" |
|
74 cellspacing="0" width="100%" bgcolor="white"> |
|
75 <tr bgcolor="#70b0f0" class="table-header"> |
|
76 <td colspan="2" class="table-header"> |
|
77 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
78 <tr valign="top"> |
|
79 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
80 <td align="right" valign="top" |
|
81 ><span class="options">[<a href="#section-InstanceMethods" |
|
82 class="privatelink" onclick="toggle_private();" |
|
83 >hide private</a>]</span></td> |
|
84 </tr> |
|
85 </table> |
|
86 </td> |
|
87 </tr> |
|
88 <tr> |
|
89 <td width="15%" align="right" valign="top" class="summary"> |
|
90 <span class="summary-type"> </span> |
|
91 </td><td class="summary"> |
|
92 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
93 <tr> |
|
94 <td><span class="summary-sig"><a href="ccm.extra.CachedSessionProvider-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
95 <span class="summary-sig-arg">opener</span>=<span class="summary-sig-default">None</span>, |
|
96 <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
97 Creates CachedSessionProvider, with a specific |
|
98 opener and cache file.</td> |
|
99 <td align="right" valign="top"> |
|
100 <span class="codelink"><a href="ccm.extra-pysrc.html#CachedSessionProvider.__init__">source code</a></span> |
|
101 |
|
102 </td> |
|
103 </tr> |
|
104 </table> |
|
105 |
|
106 </td> |
|
107 </tr> |
|
108 <tr> |
|
109 <td width="15%" align="right" valign="top" class="summary"> |
|
110 <span class="summary-type"> </span> |
|
111 </td><td class="summary"> |
|
112 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
113 <tr> |
|
114 <td><span class="summary-sig"><a href="ccm.extra.CachedSessionProvider-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
115 Closing the SessionProvider.</td> |
|
116 <td align="right" valign="top"> |
|
117 <span class="codelink"><a href="ccm.extra-pysrc.html#CachedSessionProvider.close">source code</a></span> |
|
118 |
|
119 </td> |
|
120 </tr> |
|
121 </table> |
|
122 |
|
123 </td> |
|
124 </tr> |
|
125 <tr> |
|
126 <td width="15%" align="right" valign="top" class="summary"> |
|
127 <span class="summary-type"> </span> |
|
128 </td><td class="summary"> |
|
129 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
130 <tr> |
|
131 <td><span class="summary-sig"><a name="save"></a><span class="summary-sig-name">save</span>(<span class="summary-sig-arg">self</span>)</span></td> |
|
132 <td align="right" valign="top"> |
|
133 <span class="codelink"><a href="ccm.extra-pysrc.html#CachedSessionProvider.save">source code</a></span> |
|
134 |
|
135 </td> |
|
136 </tr> |
|
137 </table> |
|
138 |
|
139 </td> |
|
140 </tr> |
|
141 <tr> |
|
142 <td width="15%" align="right" valign="top" class="summary"> |
|
143 <span class="summary-type"> </span> |
|
144 </td><td class="summary"> |
|
145 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
146 <tr> |
|
147 <td><span class="summary-sig"><a name="load"></a><span class="summary-sig-name">load</span>(<span class="summary-sig-arg">self</span>)</span></td> |
|
148 <td align="right" valign="top"> |
|
149 <span class="codelink"><a href="ccm.extra-pysrc.html#CachedSessionProvider.load">source code</a></span> |
|
150 |
|
151 </td> |
|
152 </tr> |
|
153 </table> |
|
154 |
|
155 </td> |
|
156 </tr> |
|
157 <tr> |
|
158 <td width="15%" align="right" valign="top" class="summary"> |
|
159 <span class="summary-type"> </span> |
|
160 </td><td class="summary"> |
|
161 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
162 <tr> |
|
163 <td><span class="summary-sig"><a href="ccm.extra.CachedSessionProvider-class.html#get" class="summary-sig-name">get</a>(<span class="summary-sig-arg">self</span>, |
|
164 <span class="summary-sig-arg">username</span>=<span class="summary-sig-default">None</span>, |
|
165 <span class="summary-sig-arg">password</span>=<span class="summary-sig-default">None</span>, |
|
166 <span class="summary-sig-arg">engine</span>=<span class="summary-sig-default">None</span>, |
|
167 <span class="summary-sig-arg">dbpath</span>=<span class="summary-sig-default">None</span>, |
|
168 <span class="summary-sig-arg">database</span>=<span class="summary-sig-default">None</span>, |
|
169 <span class="summary-sig-arg">reuse</span>=<span class="summary-sig-default">True</span>)</span></td> |
|
170 <td align="right" valign="top"> |
|
171 <span class="codelink"><a href="ccm.extra-pysrc.html#CachedSessionProvider.get">source code</a></span> |
|
172 |
|
173 </td> |
|
174 </tr> |
|
175 </table> |
|
176 |
|
177 </td> |
|
178 </tr> |
|
179 <tr> |
|
180 <td width="15%" align="right" valign="top" class="summary"> |
|
181 <span class="summary-type"> </span> |
|
182 </td><td class="summary"> |
|
183 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
184 <tr> |
|
185 <td><span class="summary-sig"><a name="free"></a><span class="summary-sig-name">free</span>(<span class="summary-sig-arg">self</span>, |
|
186 <span class="summary-sig-arg">session</span>)</span></td> |
|
187 <td align="right" valign="top"> |
|
188 <span class="codelink"><a href="ccm.extra-pysrc.html#CachedSessionProvider.free">source code</a></span> |
|
189 |
|
190 </td> |
|
191 </tr> |
|
192 </table> |
|
193 |
|
194 </td> |
|
195 </tr> |
|
196 <tr> |
|
197 <td colspan="2" class="summary"> |
|
198 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.extra.SessionProvider-class.html">SessionProvider</a></code></b>: |
|
199 <code><a href="ccm.extra.SessionProvider-class.html#__del__">__del__</a></code> |
|
200 </p> |
|
201 </td> |
|
202 </tr> |
|
203 </table> |
|
204 <!-- ==================== METHOD DETAILS ==================== --> |
|
205 <a name="section-MethodDetails"></a> |
|
206 <table class="details" border="1" cellpadding="3" |
|
207 cellspacing="0" width="100%" bgcolor="white"> |
|
208 <tr bgcolor="#70b0f0" class="table-header"> |
|
209 <td colspan="2" class="table-header"> |
|
210 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
211 <tr valign="top"> |
|
212 <td align="left"><span class="table-header">Method Details</span></td> |
|
213 <td align="right" valign="top" |
|
214 ><span class="options">[<a href="#section-MethodDetails" |
|
215 class="privatelink" onclick="toggle_private();" |
|
216 >hide private</a>]</span></td> |
|
217 </tr> |
|
218 </table> |
|
219 </td> |
|
220 </tr> |
|
221 </table> |
|
222 <a name="__init__"></a> |
|
223 <div> |
|
224 <table class="details" border="1" cellpadding="3" |
|
225 cellspacing="0" width="100%" bgcolor="white"> |
|
226 <tr><td> |
|
227 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
228 <tr valign="top"><td> |
|
229 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
230 <span class="sig-arg">opener</span>=<span class="sig-default">None</span>, |
|
231 <span class="sig-arg">cache</span>=<span class="sig-default">None</span>)</span> |
|
232 <br /><em class="fname">(Constructor)</em> |
|
233 </h3> |
|
234 </td><td align="right" valign="top" |
|
235 ><span class="codelink"><a href="ccm.extra-pysrc.html#CachedSessionProvider.__init__">source code</a></span> |
|
236 </td> |
|
237 </table> |
|
238 |
|
239 Creates CachedSessionProvider, with a specific |
|
240 opener and cache file. |
|
241 <dl class="fields"> |
|
242 <dt>Overrides: |
|
243 <a href="ccm.extra.SessionProvider-class.html#__init__">SessionProvider.__init__</a> |
|
244 </dt> |
|
245 </dl> |
|
246 </td></tr></table> |
|
247 </div> |
|
248 <a name="close"></a> |
|
249 <div> |
|
250 <table class="details" border="1" cellpadding="3" |
|
251 cellspacing="0" width="100%" bgcolor="white"> |
|
252 <tr><td> |
|
253 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
254 <tr valign="top"><td> |
|
255 <h3 class="epydoc"><span class="sig"><span class="sig-name">close</span>(<span class="sig-arg">self</span>)</span> |
|
256 </h3> |
|
257 </td><td align="right" valign="top" |
|
258 ><span class="codelink"><a href="ccm.extra-pysrc.html#CachedSessionProvider.close">source code</a></span> |
|
259 </td> |
|
260 </table> |
|
261 |
|
262 Closing the SessionProvider. |
|
263 <dl class="fields"> |
|
264 <dt>Overrides: |
|
265 <a href="ccm.extra.SessionProvider-class.html#close">SessionProvider.close</a> |
|
266 </dt> |
|
267 </dl> |
|
268 </td></tr></table> |
|
269 </div> |
|
270 <a name="get"></a> |
|
271 <div> |
|
272 <table class="details" border="1" cellpadding="3" |
|
273 cellspacing="0" width="100%" bgcolor="white"> |
|
274 <tr><td> |
|
275 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
276 <tr valign="top"><td> |
|
277 <h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>, |
|
278 <span class="sig-arg">username</span>=<span class="sig-default">None</span>, |
|
279 <span class="sig-arg">password</span>=<span class="sig-default">None</span>, |
|
280 <span class="sig-arg">engine</span>=<span class="sig-default">None</span>, |
|
281 <span class="sig-arg">dbpath</span>=<span class="sig-default">None</span>, |
|
282 <span class="sig-arg">database</span>=<span class="sig-default">None</span>, |
|
283 <span class="sig-arg">reuse</span>=<span class="sig-default">True</span>)</span> |
|
284 </h3> |
|
285 </td><td align="right" valign="top" |
|
286 ><span class="codelink"><a href="ccm.extra-pysrc.html#CachedSessionProvider.get">source code</a></span> |
|
287 </td> |
|
288 </table> |
|
289 |
|
290 |
|
291 <dl class="fields"> |
|
292 <dt>Overrides: |
|
293 <a href="ccm.extra.SessionProvider-class.html#get">SessionProvider.get</a> |
|
294 </dt> |
|
295 </dl> |
|
296 </td></tr></table> |
|
297 </div> |
|
298 <br /> |
|
299 <!-- ==================== NAVIGATION BAR ==================== --> |
|
300 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
301 bgcolor="#a0c0ff" cellspacing="0"> |
|
302 <tr valign="middle"> |
|
303 |
|
304 <!-- Tree link --> |
|
305 <th> <a |
|
306 href="module-tree.html">Trees</a> </th> |
|
307 |
|
308 <!-- Index link --> |
|
309 <th> <a |
|
310 href="identifier-index.html">Indices</a> </th> |
|
311 |
|
312 <!-- Help link --> |
|
313 <th> <a |
|
314 href="help.html">Help</a> </th> |
|
315 |
|
316 <th class="navbar" width="100%"></th> |
|
317 </tr> |
|
318 </table> |
|
319 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
320 <tr> |
|
321 <td align="left" class="footer"> |
|
322 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:18 2009 |
|
323 </td> |
|
324 <td align="right" class="footer"> |
|
325 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
326 </td> |
|
327 </tr> |
|
328 </table> |
|
329 |
|
330 <script type="text/javascript"> |
|
331 <!-- |
|
332 // Private objects are initially displayed (because if |
|
333 // javascript is turned off then we want them to be |
|
334 // visible); but by default, we want to hide them. So hide |
|
335 // them unless we have a cookie that says to show them. |
|
336 checkCookie() |
|
337 // --> |
|
338 </script> |
|
339 |
|
340 </body> |
|
341 </html> |