Documentation/Source/eric5.Utilities.BackgroundService.html

changeset 3591
2f2a4a76dd22
parent 3579
eccd12461319
equal deleted inserted replaced
3590:5280e37405b8 3591:2f2a4a76dd22
72 </tr><tr> 72 </tr><tr>
73 <td><a href="#BackgroundService.__startExternalClient">__startExternalClient</a></td> 73 <td><a href="#BackgroundService.__startExternalClient">__startExternalClient</a></td>
74 <td>Private method to start the background client as external process.</td> 74 <td>Private method to start the background client as external process.</td>
75 </tr><tr> 75 </tr><tr>
76 <td><a href="#BackgroundService.enqueueRequest">enqueueRequest</a></td> 76 <td><a href="#BackgroundService.enqueueRequest">enqueueRequest</a></td>
77 <td>Implement a queued processing of incomming events.</td> 77 <td>Public method implementing a queued processing of incomming events.</td>
78 </tr><tr> 78 </tr><tr>
79 <td><a href="#BackgroundService.on_disconnectSocket">on_disconnectSocket</a></td> 79 <td><a href="#BackgroundService.on_disconnectSocket">on_disconnectSocket</a></td>
80 <td>Slot is called when connection to a client is lost.</td> 80 <td>Private slot called when connection to a client is lost.</td>
81 </tr><tr> 81 </tr><tr>
82 <td><a href="#BackgroundService.on_newConnection">on_newConnection</a></td> 82 <td><a href="#BackgroundService.on_newConnection">on_newConnection</a></td>
83 <td>Slot for new incomming connections from the clients.</td> 83 <td>Private slot for new incomming connections from the clients.</td>
84 </tr><tr> 84 </tr><tr>
85 <td><a href="#BackgroundService.preferencesOrProjectChanged">preferencesOrProjectChanged</a></td> 85 <td><a href="#BackgroundService.preferencesOrProjectChanged">preferencesOrProjectChanged</a></td>
86 <td>Public slot to restart the built in languages.</td> 86 <td>Public slot to restart the built in languages.</td>
87 </tr><tr> 87 </tr><tr>
88 <td><a href="#BackgroundService.restartService">restartService</a></td> 88 <td><a href="#BackgroundService.restartService">restartService</a></td>
89 <td>Public method to restart a given lanuage.</td> 89 <td>Public method to restart a given lanuage.</td>
90 </tr><tr> 90 </tr><tr>
91 <td><a href="#BackgroundService.serviceConnect">serviceConnect</a></td> 91 <td><a href="#BackgroundService.serviceConnect">serviceConnect</a></td>
92 <td>Announce a new service to the background service/ client.</td> 92 <td>Public method to announce a new service to the background service/client.</td>
93 </tr><tr> 93 </tr><tr>
94 <td><a href="#BackgroundService.serviceDisconnect">serviceDisconnect</a></td> 94 <td><a href="#BackgroundService.serviceDisconnect">serviceDisconnect</a></td>
95 <td>Remove the service from the service list.</td> 95 <td>Public method to remove the service from the service list.</td>
96 </tr><tr> 96 </tr><tr>
97 <td><a href="#BackgroundService.shutdown">shutdown</a></td> 97 <td><a href="#BackgroundService.shutdown">shutdown</a></td>
98 <td>Cleanup the connections and processes when eric is shuting down.</td> 98 <td>Public method to cleanup the connections and processes when eric is shuting down.</td>
99 </tr> 99 </tr>
100 </table> 100 </table>
101 <h3>Static Methods</h3> 101 <h3>Static Methods</h3>
102 <table> 102 <table>
103 <tr><td>None</td></tr> 103 <tr><td>None</td></tr>
162 </dd> 162 </dd>
163 </dl><a NAME="BackgroundService.enqueueRequest" ID="BackgroundService.enqueueRequest"></a> 163 </dl><a NAME="BackgroundService.enqueueRequest" ID="BackgroundService.enqueueRequest"></a>
164 <h4>BackgroundService.enqueueRequest</h4> 164 <h4>BackgroundService.enqueueRequest</h4>
165 <b>enqueueRequest</b>(<i>fx, lang, fn, data</i>) 165 <b>enqueueRequest</b>(<i>fx, lang, fn, data</i>)
166 <p> 166 <p>
167 Implement a queued processing of incomming events. 167 Public method implementing a queued processing of incomming events.
168 </p><p> 168 </p><p>
169 Dublicate service requests updates an older request to avoid overrun or 169 Dublicate service requests updates an older request to avoid overrun or
170 starving of the services. 170 starving of the services.
171 </p><dl> 171 </p><dl>
172 <dt><i>fx</i></dt> 172 <dt><i>fx</i></dt>
184 </dd> 184 </dd>
185 </dl><a NAME="BackgroundService.on_disconnectSocket" ID="BackgroundService.on_disconnectSocket"></a> 185 </dl><a NAME="BackgroundService.on_disconnectSocket" ID="BackgroundService.on_disconnectSocket"></a>
186 <h4>BackgroundService.on_disconnectSocket</h4> 186 <h4>BackgroundService.on_disconnectSocket</h4>
187 <b>on_disconnectSocket</b>(<i>lang</i>) 187 <b>on_disconnectSocket</b>(<i>lang</i>)
188 <p> 188 <p>
189 Slot is called when connection to a client is lost. 189 Private slot called when connection to a client is lost.
190 </p><dl> 190 </p><dl>
191 <dt><i>lang</i></dt> 191 <dt><i>lang</i></dt>
192 <dd> 192 <dd>
193 client language which connection is lost (str) 193 client language which connection is lost (str)
194 </dd> 194 </dd>
195 </dl><a NAME="BackgroundService.on_newConnection" ID="BackgroundService.on_newConnection"></a> 195 </dl><a NAME="BackgroundService.on_newConnection" ID="BackgroundService.on_newConnection"></a>
196 <h4>BackgroundService.on_newConnection</h4> 196 <h4>BackgroundService.on_newConnection</h4>
197 <b>on_newConnection</b>(<i></i>) 197 <b>on_newConnection</b>(<i></i>)
198 <p> 198 <p>
199 Slot for new incomming connections from the clients. 199 Private slot for new incomming connections from the clients.
200 </p><a NAME="BackgroundService.preferencesOrProjectChanged" ID="BackgroundService.preferencesOrProjectChanged"></a> 200 </p><a NAME="BackgroundService.preferencesOrProjectChanged" ID="BackgroundService.preferencesOrProjectChanged"></a>
201 <h4>BackgroundService.preferencesOrProjectChanged</h4> 201 <h4>BackgroundService.preferencesOrProjectChanged</h4>
202 <b>preferencesOrProjectChanged</b>(<i></i>) 202 <b>preferencesOrProjectChanged</b>(<i></i>)
203 <p> 203 <p>
204 Public slot to restart the built in languages. 204 Public slot to restart the built in languages.
217 </dd> 217 </dd>
218 </dl><a NAME="BackgroundService.serviceConnect" ID="BackgroundService.serviceConnect"></a> 218 </dl><a NAME="BackgroundService.serviceConnect" ID="BackgroundService.serviceConnect"></a>
219 <h4>BackgroundService.serviceConnect</h4> 219 <h4>BackgroundService.serviceConnect</h4>
220 <b>serviceConnect</b>(<i>fx, lang, modulepath, module, callback, onErrorCallback=None</i>) 220 <b>serviceConnect</b>(<i>fx, lang, modulepath, module, callback, onErrorCallback=None</i>)
221 <p> 221 <p>
222 Announce a new service to the background service/ client. 222 Public method to announce a new service to the background
223 service/client.
223 </p><dl> 224 </p><dl>
224 <dt><i>fx</i></dt> 225 <dt><i>fx</i></dt>
225 <dd> 226 <dd>
226 function name of the service (str) 227 function name of the service (str)
227 </dd><dt><i>lang</i></dt> 228 </dd><dt><i>lang</i></dt>
242 </dd> 243 </dd>
243 </dl><a NAME="BackgroundService.serviceDisconnect" ID="BackgroundService.serviceDisconnect"></a> 244 </dl><a NAME="BackgroundService.serviceDisconnect" ID="BackgroundService.serviceDisconnect"></a>
244 <h4>BackgroundService.serviceDisconnect</h4> 245 <h4>BackgroundService.serviceDisconnect</h4>
245 <b>serviceDisconnect</b>(<i>fx, lang</i>) 246 <b>serviceDisconnect</b>(<i>fx, lang</i>)
246 <p> 247 <p>
247 Remove the service from the service list. 248 Public method to remove the service from the service list.
248 </p><dl> 249 </p><dl>
249 <dt><i>fx</i></dt> 250 <dt><i>fx</i></dt>
250 <dd> 251 <dd>
251 function name of the service (function) 252 function name of the service (function)
252 </dd><dt><i>lang</i></dt> 253 </dd><dt><i>lang</i></dt>
255 </dd> 256 </dd>
256 </dl><a NAME="BackgroundService.shutdown" ID="BackgroundService.shutdown"></a> 257 </dl><a NAME="BackgroundService.shutdown" ID="BackgroundService.shutdown"></a>
257 <h4>BackgroundService.shutdown</h4> 258 <h4>BackgroundService.shutdown</h4>
258 <b>shutdown</b>(<i></i>) 259 <b>shutdown</b>(<i></i>)
259 <p> 260 <p>
260 Cleanup the connections and processes when eric is shuting down. 261 Public method to cleanup the connections and processes when eric is
262 shuting down.
261 </p> 263 </p>
262 <div align="right"><a href="#top">Up</a></div> 264 <div align="right"><a href="#top">Up</a></div>
263 <hr /> 265 <hr />
264 </body></html> 266 </body></html>

eric ide

mercurial