|
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.Session</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 Class Session |
|
39 </span> |
|
40 </td> |
|
41 <td> |
|
42 <table cellpadding="0" cellspacing="0"> |
|
43 <!-- hide/show private --> |
|
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
45 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
46 <tr><td align="right"><span class="options" |
|
47 >[<a href="frames.html" target="_top">frames</a |
|
48 >] | <a href="ccm.Session-class.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Class Session</h1><span class="codelink"><a href="ccm-pysrc.html#Session">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 object --+ |
|
58 | |
|
59 <a href="ccm.AbstractSession-class.html">AbstractSession</a> --+ |
|
60 | |
|
61 <strong class="uidshort">Session</strong> |
|
62 </pre> |
|
63 |
|
64 <hr /> |
|
65 A Synergy session.<br /><br /> |
|
66 |
|
67 <!-- ==================== INSTANCE METHODS ==================== --> |
|
68 <a name="section-InstanceMethods"></a> |
|
69 <table class="summary" border="1" cellpadding="3" |
|
70 cellspacing="0" width="100%" bgcolor="white"> |
|
71 <tr bgcolor="#70b0f0" class="table-header"> |
|
72 <td colspan="2" class="table-header"> |
|
73 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
74 <tr valign="top"> |
|
75 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
76 <td align="right" valign="top" |
|
77 ><span class="options">[<a href="#section-InstanceMethods" |
|
78 class="privatelink" onclick="toggle_private();" |
|
79 >hide private</a>]</span></td> |
|
80 </tr> |
|
81 </table> |
|
82 </td> |
|
83 </tr> |
|
84 <tr> |
|
85 <td width="15%" align="right" valign="top" class="summary"> |
|
86 <span class="summary-type"> </span> |
|
87 </td><td class="summary"> |
|
88 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
89 <tr> |
|
90 <td><span class="summary-sig"><a href="ccm.Session-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
91 <span class="summary-sig-arg">username</span>, |
|
92 <span class="summary-sig-arg">engine</span>, |
|
93 <span class="summary-sig-arg">dbpath</span>, |
|
94 <span class="summary-sig-arg">ccm_addr</span>, |
|
95 <span class="summary-sig-arg">close_on_exit</span>=<span class="summary-sig-default">True</span>)</span><br /> |
|
96 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> |
|
97 <td align="right" valign="top"> |
|
98 <span class="codelink"><a href="ccm-pysrc.html#Session.__init__">source code</a></span> |
|
99 |
|
100 </td> |
|
101 </tr> |
|
102 </table> |
|
103 |
|
104 </td> |
|
105 </tr> |
|
106 <tr> |
|
107 <td width="15%" align="right" valign="top" class="summary"> |
|
108 <span class="summary-type"> </span> |
|
109 </td><td class="summary"> |
|
110 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
111 <tr> |
|
112 <td><span class="summary-sig"><a href="ccm.Session-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>, |
|
113 <span class="summary-sig-arg">cmdline</span>, |
|
114 <span class="summary-sig-arg">result</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
115 Executes a Synergy CLI operation.</td> |
|
116 <td align="right" valign="top"> |
|
117 <span class="codelink"><a href="ccm-pysrc.html#Session.execute">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 href="ccm.Session-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
132 Closes this Synergy session if it was not previously running anyway.</td> |
|
133 <td align="right" valign="top"> |
|
134 <span class="codelink"><a href="ccm-pysrc.html#Session.close">source code</a></span> |
|
135 |
|
136 </td> |
|
137 </tr> |
|
138 </table> |
|
139 |
|
140 </td> |
|
141 </tr> |
|
142 <tr> |
|
143 <td colspan="2" class="summary"> |
|
144 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.AbstractSession-class.html">AbstractSession</a></code></b>: |
|
145 <code><a href="ccm.AbstractSession-class.html#__del__">__del__</a></code>, |
|
146 <code><a href="ccm.AbstractSession-class.html#__repr__">__repr__</a></code>, |
|
147 <code><a href="ccm.AbstractSession-class.html#__str__">__str__</a></code>, |
|
148 <code><a href="ccm.AbstractSession-class.html#addr">addr</a></code>, |
|
149 <code><a href="ccm.AbstractSession-class.html#create">create</a></code>, |
|
150 <code><a href="ccm.AbstractSession-class.html#database">database</a></code>, |
|
151 <code><a href="ccm.AbstractSession-class.html#get_workarea_info">get_workarea_info</a></code>, |
|
152 <code><a href="ccm.AbstractSession-class.html#purposes">purposes</a></code> |
|
153 </p> |
|
154 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.AbstractSession-class.html">AbstractSession</a></code></b> (private): |
|
155 <code><a href="ccm.AbstractSession-class.html#_get_home">_get_home</a></code>, |
|
156 <code><a href="ccm.AbstractSession-class.html#_get_role">_get_role</a></code>, |
|
157 <code><a href="ccm.AbstractSession-class.html#_set_home">_set_home</a></code>, |
|
158 <code><a href="ccm.AbstractSession-class.html#_set_role">_set_role</a></code>, |
|
159 <code><a href="ccm.AbstractSession-class.html#_set_role_internal">_set_role_internal</a></code> |
|
160 </p></div> |
|
161 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
162 <code>__delattr__</code>, |
|
163 <code>__getattribute__</code>, |
|
164 <code>__hash__</code>, |
|
165 <code>__new__</code>, |
|
166 <code>__reduce__</code>, |
|
167 <code>__reduce_ex__</code>, |
|
168 <code>__setattr__</code> |
|
169 </p> |
|
170 </td> |
|
171 </tr> |
|
172 </table> |
|
173 <!-- ==================== STATIC METHODS ==================== --> |
|
174 <a name="section-StaticMethods"></a> |
|
175 <table class="summary" border="1" cellpadding="3" |
|
176 cellspacing="0" width="100%" bgcolor="white"> |
|
177 <tr bgcolor="#70b0f0" class="table-header"> |
|
178 <td colspan="2" class="table-header"> |
|
179 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
180 <tr valign="top"> |
|
181 <td align="left"><span class="table-header">Static Methods</span></td> |
|
182 <td align="right" valign="top" |
|
183 ><span class="options">[<a href="#section-StaticMethods" |
|
184 class="privatelink" onclick="toggle_private();" |
|
185 >hide private</a>]</span></td> |
|
186 </tr> |
|
187 </table> |
|
188 </td> |
|
189 </tr> |
|
190 <tr> |
|
191 <td width="15%" align="right" valign="top" class="summary"> |
|
192 <span class="summary-type"> </span> |
|
193 </td><td class="summary"> |
|
194 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
195 <tr> |
|
196 <td><span class="summary-sig"><a name="start"></a><span class="summary-sig-name">start</span>(<span class="summary-sig-arg">username</span>, |
|
197 <span class="summary-sig-arg">password</span>, |
|
198 <span class="summary-sig-arg">engine</span>, |
|
199 <span class="summary-sig-arg">dbpath</span>, |
|
200 <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">300</span>)</span></td> |
|
201 <td align="right" valign="top"> |
|
202 <span class="codelink"><a href="ccm-pysrc.html#Session.start">source code</a></span> |
|
203 |
|
204 </td> |
|
205 </tr> |
|
206 </table> |
|
207 |
|
208 </td> |
|
209 </tr> |
|
210 </table> |
|
211 <!-- ==================== CLASS VARIABLES ==================== --> |
|
212 <a name="section-ClassVariables"></a> |
|
213 <table class="summary" border="1" cellpadding="3" |
|
214 cellspacing="0" width="100%" bgcolor="white"> |
|
215 <tr bgcolor="#70b0f0" class="table-header"> |
|
216 <td colspan="2" class="table-header"> |
|
217 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
218 <tr valign="top"> |
|
219 <td align="left"><span class="table-header">Class Variables</span></td> |
|
220 <td align="right" valign="top" |
|
221 ><span class="options">[<a href="#section-ClassVariables" |
|
222 class="privatelink" onclick="toggle_private();" |
|
223 >hide private</a>]</span></td> |
|
224 </tr> |
|
225 </table> |
|
226 </td> |
|
227 </tr> |
|
228 <tr> |
|
229 <td colspan="2" class="summary"> |
|
230 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.AbstractSession-class.html">AbstractSession</a></code></b>: |
|
231 <code><a href="ccm.AbstractSession-class.html#home">home</a></code>, |
|
232 <code><a href="ccm.AbstractSession-class.html#role">role</a></code> |
|
233 </p> |
|
234 </td> |
|
235 </tr> |
|
236 </table> |
|
237 <!-- ==================== PROPERTIES ==================== --> |
|
238 <a name="section-Properties"></a> |
|
239 <table class="summary" border="1" cellpadding="3" |
|
240 cellspacing="0" width="100%" bgcolor="white"> |
|
241 <tr bgcolor="#70b0f0" class="table-header"> |
|
242 <td colspan="2" class="table-header"> |
|
243 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
244 <tr valign="top"> |
|
245 <td align="left"><span class="table-header">Properties</span></td> |
|
246 <td align="right" valign="top" |
|
247 ><span class="options">[<a href="#section-Properties" |
|
248 class="privatelink" onclick="toggle_private();" |
|
249 >hide private</a>]</span></td> |
|
250 </tr> |
|
251 </table> |
|
252 </td> |
|
253 </tr> |
|
254 <tr> |
|
255 <td colspan="2" class="summary"> |
|
256 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
257 <code>__class__</code> |
|
258 </p> |
|
259 </td> |
|
260 </tr> |
|
261 </table> |
|
262 <!-- ==================== METHOD DETAILS ==================== --> |
|
263 <a name="section-MethodDetails"></a> |
|
264 <table class="details" border="1" cellpadding="3" |
|
265 cellspacing="0" width="100%" bgcolor="white"> |
|
266 <tr bgcolor="#70b0f0" class="table-header"> |
|
267 <td colspan="2" class="table-header"> |
|
268 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
269 <tr valign="top"> |
|
270 <td align="left"><span class="table-header">Method Details</span></td> |
|
271 <td align="right" valign="top" |
|
272 ><span class="options">[<a href="#section-MethodDetails" |
|
273 class="privatelink" onclick="toggle_private();" |
|
274 >hide private</a>]</span></td> |
|
275 </tr> |
|
276 </table> |
|
277 </td> |
|
278 </tr> |
|
279 </table> |
|
280 <a name="__init__"></a> |
|
281 <div> |
|
282 <table class="details" border="1" cellpadding="3" |
|
283 cellspacing="0" width="100%" bgcolor="white"> |
|
284 <tr><td> |
|
285 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
286 <tr valign="top"><td> |
|
287 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
288 <span class="sig-arg">username</span>, |
|
289 <span class="sig-arg">engine</span>, |
|
290 <span class="sig-arg">dbpath</span>, |
|
291 <span class="sig-arg">ccm_addr</span>, |
|
292 <span class="sig-arg">close_on_exit</span>=<span class="sig-default">True</span>)</span> |
|
293 <br /><em class="fname">(Constructor)</em> |
|
294 </h3> |
|
295 </td><td align="right" valign="top" |
|
296 ><span class="codelink"><a href="ccm-pysrc.html#Session.__init__">source code</a></span> |
|
297 </td> |
|
298 </table> |
|
299 |
|
300 x.__init__(...) initializes x; see x.__class__.__doc__ for signature |
|
301 <dl class="fields"> |
|
302 <dt>Overrides: |
|
303 <a href="ccm.AbstractSession-class.html#__init__">AbstractSession.__init__</a> |
|
304 </dt> |
|
305 </dl> |
|
306 </td></tr></table> |
|
307 </div> |
|
308 <a name="execute"></a> |
|
309 <div> |
|
310 <table class="details" border="1" cellpadding="3" |
|
311 cellspacing="0" width="100%" bgcolor="white"> |
|
312 <tr><td> |
|
313 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
314 <tr valign="top"><td> |
|
315 <h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>, |
|
316 <span class="sig-arg">cmdline</span>, |
|
317 <span class="sig-arg">result</span>=<span class="sig-default">None</span>)</span> |
|
318 </h3> |
|
319 </td><td align="right" valign="top" |
|
320 ><span class="codelink"><a href="ccm-pysrc.html#Session.execute">source code</a></span> |
|
321 </td> |
|
322 </table> |
|
323 |
|
324 Executes a Synergy CLI operation. |
|
325 <dl class="fields"> |
|
326 <dt>Overrides: |
|
327 <a href="ccm.AbstractSession-class.html#execute">AbstractSession.execute</a> |
|
328 </dt> |
|
329 </dl> |
|
330 </td></tr></table> |
|
331 </div> |
|
332 <a name="close"></a> |
|
333 <div> |
|
334 <table class="details" border="1" cellpadding="3" |
|
335 cellspacing="0" width="100%" bgcolor="white"> |
|
336 <tr><td> |
|
337 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
338 <tr valign="top"><td> |
|
339 <h3 class="epydoc"><span class="sig"><span class="sig-name">close</span>(<span class="sig-arg">self</span>)</span> |
|
340 </h3> |
|
341 </td><td align="right" valign="top" |
|
342 ><span class="codelink"><a href="ccm-pysrc.html#Session.close">source code</a></span> |
|
343 </td> |
|
344 </table> |
|
345 |
|
346 Closes this Synergy session if it was not previously running anyway. |
|
347 <dl class="fields"> |
|
348 <dt>Overrides: |
|
349 <a href="ccm.AbstractSession-class.html#close">AbstractSession.close</a> |
|
350 </dt> |
|
351 </dl> |
|
352 </td></tr></table> |
|
353 </div> |
|
354 <br /> |
|
355 <!-- ==================== NAVIGATION BAR ==================== --> |
|
356 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
357 bgcolor="#a0c0ff" cellspacing="0"> |
|
358 <tr valign="middle"> |
|
359 |
|
360 <!-- Tree link --> |
|
361 <th> <a |
|
362 href="module-tree.html">Trees</a> </th> |
|
363 |
|
364 <!-- Index link --> |
|
365 <th> <a |
|
366 href="identifier-index.html">Indices</a> </th> |
|
367 |
|
368 <!-- Help link --> |
|
369 <th> <a |
|
370 href="help.html">Help</a> </th> |
|
371 |
|
372 <th class="navbar" width="100%"></th> |
|
373 </tr> |
|
374 </table> |
|
375 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
376 <tr> |
|
377 <td align="left" class="footer"> |
|
378 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:18 2009 |
|
379 </td> |
|
380 <td align="right" class="footer"> |
|
381 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
382 </td> |
|
383 </tr> |
|
384 </table> |
|
385 |
|
386 <script type="text/javascript"> |
|
387 <!-- |
|
388 // Private objects are initially displayed (because if |
|
389 // javascript is turned off then we want them to be |
|
390 // visible); but by default, we want to hide them. So hide |
|
391 // them unless we have a cookie that says to show them. |
|
392 checkCookie() |
|
393 // --> |
|
394 </script> |
|
395 |
|
396 </body> |
|
397 </html> |