|
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>nokia.nokiaccm</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="nokia-module.html">Package nokia</a> :: |
|
38 Module nokiaccm |
|
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="nokia.nokiaccm-module.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== MODULE DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Module nokiaccm</h1><span class="codelink"><a href="nokia.nokiaccm-pysrc.html">source code</a></span><br /><br /> |
|
56 Nokia specific interface to Synergy sessions.<br /><br /> |
|
57 |
|
58 <!-- ==================== FUNCTIONS ==================== --> |
|
59 <a name="section-Functions"></a> |
|
60 <table class="summary" border="1" cellpadding="3" |
|
61 cellspacing="0" width="100%" bgcolor="white"> |
|
62 <tr bgcolor="#70b0f0" class="table-header"> |
|
63 <td colspan="2" class="table-header"> |
|
64 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
65 <tr valign="top"> |
|
66 <td align="left"><span class="table-header">Functions</span></td> |
|
67 <td align="right" valign="top" |
|
68 ><span class="options">[<a href="#section-Functions" |
|
69 class="privatelink" onclick="toggle_private();" |
|
70 >hide private</a>]</span></td> |
|
71 </tr> |
|
72 </table> |
|
73 </td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td width="15%" align="right" valign="top" class="summary"> |
|
77 <span class="summary-type"> </span> |
|
78 </td><td class="summary"> |
|
79 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
80 <tr> |
|
81 <td><span class="summary-sig"><a href="nokia.nokiaccm-module.html#open_session" class="summary-sig-name">open_session</a>(<span class="summary-sig-arg">username</span>=<span class="summary-sig-default">None</span>, |
|
82 <span class="summary-sig-arg">password</span>=<span class="summary-sig-default">None</span>, |
|
83 <span class="summary-sig-arg">engine</span>=<span class="summary-sig-default">None</span>, |
|
84 <span class="summary-sig-arg">dbpath</span>=<span class="summary-sig-default">None</span>, |
|
85 <span class="summary-sig-arg">database</span>=<span class="summary-sig-default">None</span>, |
|
86 <span class="summary-sig-arg">reuse</span>=<span class="summary-sig-default">True</span>)</span><br /> |
|
87 Provides a Session object.</td> |
|
88 <td align="right" valign="top"> |
|
89 <span class="codelink"><a href="nokia.nokiaccm-pysrc.html#open_session">source code</a></span> |
|
90 |
|
91 </td> |
|
92 </tr> |
|
93 </table> |
|
94 |
|
95 </td> |
|
96 </tr> |
|
97 </table> |
|
98 <!-- ==================== VARIABLES ==================== --> |
|
99 <a name="section-Variables"></a> |
|
100 <table class="summary" border="1" cellpadding="3" |
|
101 cellspacing="0" width="100%" bgcolor="white"> |
|
102 <tr bgcolor="#70b0f0" class="table-header"> |
|
103 <td colspan="2" class="table-header"> |
|
104 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
105 <tr valign="top"> |
|
106 <td align="left"><span class="table-header">Variables</span></td> |
|
107 <td align="right" valign="top" |
|
108 ><span class="options">[<a href="#section-Variables" |
|
109 class="privatelink" onclick="toggle_private();" |
|
110 >hide private</a>]</span></td> |
|
111 </tr> |
|
112 </table> |
|
113 </td> |
|
114 </tr> |
|
115 <tr class="private"> |
|
116 <td width="15%" align="right" valign="top" class="summary"> |
|
117 <span class="summary-type"> </span> |
|
118 </td><td class="summary"> |
|
119 <a name="_logger"></a><span class="summary-name">_logger</span> = <code title="logging.getLogger("nokia.nokiaccm")">logging.getLogger("nokia.nokiaccm")</code> |
|
120 </td> |
|
121 </tr> |
|
122 </table> |
|
123 <!-- ==================== FUNCTION DETAILS ==================== --> |
|
124 <a name="section-FunctionDetails"></a> |
|
125 <table class="details" border="1" cellpadding="3" |
|
126 cellspacing="0" width="100%" bgcolor="white"> |
|
127 <tr bgcolor="#70b0f0" class="table-header"> |
|
128 <td colspan="2" class="table-header"> |
|
129 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
130 <tr valign="top"> |
|
131 <td align="left"><span class="table-header">Function Details</span></td> |
|
132 <td align="right" valign="top" |
|
133 ><span class="options">[<a href="#section-FunctionDetails" |
|
134 class="privatelink" onclick="toggle_private();" |
|
135 >hide private</a>]</span></td> |
|
136 </tr> |
|
137 </table> |
|
138 </td> |
|
139 </tr> |
|
140 </table> |
|
141 <a name="open_session"></a> |
|
142 <div> |
|
143 <table class="details" border="1" cellpadding="3" |
|
144 cellspacing="0" width="100%" bgcolor="white"> |
|
145 <tr><td> |
|
146 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
147 <tr valign="top"><td> |
|
148 <h3 class="epydoc"><span class="sig"><span class="sig-name">open_session</span>(<span class="sig-arg">username</span>=<span class="sig-default">None</span>, |
|
149 <span class="sig-arg">password</span>=<span class="sig-default">None</span>, |
|
150 <span class="sig-arg">engine</span>=<span class="sig-default">None</span>, |
|
151 <span class="sig-arg">dbpath</span>=<span class="sig-default">None</span>, |
|
152 <span class="sig-arg">database</span>=<span class="sig-default">None</span>, |
|
153 <span class="sig-arg">reuse</span>=<span class="sig-default">True</span>)</span> |
|
154 </h3> |
|
155 </td><td align="right" valign="top" |
|
156 ><span class="codelink"><a href="nokia.nokiaccm-pysrc.html#open_session">source code</a></span> |
|
157 </td> |
|
158 </table> |
|
159 |
|
160 <p>Provides a Session object.</p> |
|
161 <p>Attempts to return a Session, based either on existing Synergy |
|
162 sessions or by creating a new one.</p> |
|
163 <ul> |
|
164 <li><p class="rst-first">If a .netrc file can be found on the user's personal drive, |
|
165 that will be read to obtain Synergy login information if it |
|
166 is defined there. This will be used to fill in any missing |
|
167 parameters not passed in the call to open_session().</p> |
|
168 <p>The format of the .netrc file entries should be:</p> |
|
169 <p>machine synergy login USERNAME password foobar account <a class="rst-reference external" href="mailto:DATABASE_PATH@SERVER" target="_top">DATABASE_PATH@SERVER</a></p> |
|
170 <p>If the details refer to a specific database, the machine can be the database name, |
|
171 instead of "synergy".</p> |
|
172 </li> |
|
173 <li><p class="rst-first">If an existing session is running that matches the supplied |
|
174 parameters, it will reuse that.</p> |
|
175 </li> |
|
176 </ul> |
|
177 <dl class="fields"> |
|
178 </dl> |
|
179 </td></tr></table> |
|
180 </div> |
|
181 <br /> |
|
182 <!-- ==================== NAVIGATION BAR ==================== --> |
|
183 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
184 bgcolor="#a0c0ff" cellspacing="0"> |
|
185 <tr valign="middle"> |
|
186 |
|
187 <!-- Tree link --> |
|
188 <th> <a |
|
189 href="module-tree.html">Trees</a> </th> |
|
190 |
|
191 <!-- Index link --> |
|
192 <th> <a |
|
193 href="identifier-index.html">Indices</a> </th> |
|
194 |
|
195 <!-- Help link --> |
|
196 <th> <a |
|
197 href="help.html">Help</a> </th> |
|
198 |
|
199 <th class="navbar" width="100%"></th> |
|
200 </tr> |
|
201 </table> |
|
202 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
203 <tr> |
|
204 <td align="left" class="footer"> |
|
205 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009 |
|
206 </td> |
|
207 <td align="right" class="footer"> |
|
208 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
209 </td> |
|
210 </tr> |
|
211 </table> |
|
212 |
|
213 <script type="text/javascript"> |
|
214 <!-- |
|
215 // Private objects are initially displayed (because if |
|
216 // javascript is turned off then we want them to be |
|
217 // visible); but by default, we want to hide them. So hide |
|
218 // them unless we have a cookie that says to show them. |
|
219 checkCookie() |
|
220 // --> |
|
221 </script> |
|
222 |
|
223 </body> |
|
224 </html> |