Mercurial Repositories > eric / file diff

diff: eric6/Documentation/Source/eric6.Utilities.BackgroundService.html

eric6/Documentation/Source/eric6.Utilities.BackgroundService.html

changeset 7965
48fbf9149d16
parent 7900
72b88fb20261
child 7989
a21d673a8f99
--- a/eric6/Documentation/Source/eric6.Utilities.BackgroundService.html	Thu Jan 07 17:22:16 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Utilities.BackgroundService.html	Thu Jan 07 18:11:11 2021 +0100
@@ -24,7 +24,7 @@
 
 <p>
 Module implementing a background service for the various checkers and other
-python interpreter dependent functions.
+Python interpreter dependent functions.
 </p>
 <h3>Global Attributes</h3>
 
@@ -85,7 +85,7 @@
 
 <tr>
 <td><a href="#BackgroundService.__init__">BackgroundService</a></td>
-<td>Constructor of the BackgroundService class.</td>
+<td>Constructor</td>
 </tr>
 <tr>
 <td><a href="#BackgroundService.__processQueue">__processQueue</a></td>
@@ -105,7 +105,7 @@
 </tr>
 <tr>
 <td><a href="#BackgroundService.enqueueRequest">enqueueRequest</a></td>
-<td>Public method implementing a queued processing of incomming events.</td>
+<td>Public method implementing a queued processing of incoming events.</td>
 </tr>
 <tr>
 <td><a href="#BackgroundService.on_disconnectSocket">on_disconnectSocket</a></td>
@@ -113,7 +113,7 @@
 </tr>
 <tr>
 <td><a href="#BackgroundService.on_newConnection">on_newConnection</a></td>
-<td>Private slot for new incomming connections from the clients.</td>
+<td>Private slot for new incoming connections from the clients.</td>
 </tr>
 <tr>
 <td><a href="#BackgroundService.preferencesOrProjectChanged">preferencesOrProjectChanged</a></td>
@@ -125,7 +125,7 @@
 </tr>
 <tr>
 <td><a href="#BackgroundService.restartService">restartService</a></td>
-<td>Public method to restart a given lanuage.</td>
+<td>Public method to restart a given language.</td>
 </tr>
 <tr>
 <td><a href="#BackgroundService.serviceConnect">serviceConnect</a></td>
@@ -151,7 +151,7 @@
 <b>BackgroundService</b>(<i></i>)
 
 <p>
-        Constructor of the BackgroundService class.
+        Constructor
 </p>
 <a NAME="BackgroundService.__processQueue" ID="BackgroundService.__processQueue"></a>
 <h4>BackgroundService.__processQueue</h4>
@@ -170,9 +170,9 @@
 </p>
 <dl>
 
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language of the incomming connection (str)
+language of the incoming connection
 </dd>
 </dl>
 <dl>
@@ -191,21 +191,21 @@
 </p>
 <dl>
 
-<dt><i>fx</i></dt>
+<dt><i>fx</i> (str)</dt>
 <dd>
-remote function name to execute (str)
+remote function name to execute
 </dd>
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language to connect to (str)
+language to connect to
 </dd>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-filename for identification (str)
+filename for identification
 </dd>
-<dt><i>data</i></dt>
+<dt><i>data</i> (any basic datatype)</dt>
 <dd>
-function argument(s) (any basic datatype)
+function argument(s)
 </dd>
 </dl>
 <a NAME="BackgroundService.__startExternalClient" ID="BackgroundService.__startExternalClient"></a>
@@ -217,19 +217,25 @@
 </p>
 <dl>
 
-<dt><i>interpreter</i></dt>
+<dt><i>interpreter</i> (str)</dt>
 <dd>
-path and name of the executable to start (string)
+path and name of the executable to start
 </dd>
-<dt><i>port</i></dt>
+<dt><i>port</i> (int)</dt>
 <dd>
-socket port to which the interpreter should connect (int)
+socket port to which the interpreter should connect
 </dd>
 </dl>
 <dl>
 <dt>Returns:</dt>
 <dd>
-the process object (QProcess or None)
+the process object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QProcess or None
 </dd>
 </dl>
 <a NAME="BackgroundService.enqueueRequest" ID="BackgroundService.enqueueRequest"></a>
@@ -237,29 +243,29 @@
 <b>enqueueRequest</b>(<i>fx, lang, fn, data</i>)
 
 <p>
-        Public method implementing a queued processing of incomming events.
+        Public method implementing a queued processing of incoming events.
 </p>
 <p>
-        Dublicate service requests updates an older request to avoid overrun or
+        Duplicate service requests update an older request to avoid overrun or
         starving of the services.
 </p>
 <dl>
 
-<dt><i>fx</i></dt>
+<dt><i>fx</i> (str)</dt>
 <dd>
-function name of the service (str)
+function name of the service
 </dd>
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language to connect to (str)
+language to connect to
 </dd>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-filename for identification (str)
+filename for identification
 </dd>
-<dt><i>data</i></dt>
+<dt><i>data</i> (any basic datatype)</dt>
 <dd>
-function argument(s) (any basic datatype(s))
+function argument(s)
 </dd>
 </dl>
 <a NAME="BackgroundService.on_disconnectSocket" ID="BackgroundService.on_disconnectSocket"></a>
@@ -271,9 +277,9 @@
 </p>
 <dl>
 
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-client language which connection is lost (str)
+client language which connection is lost
 </dd>
 </dl>
 <a NAME="BackgroundService.on_newConnection" ID="BackgroundService.on_newConnection"></a>
@@ -281,7 +287,7 @@
 <b>on_newConnection</b>(<i></i>)
 
 <p>
-        Private slot for new incomming connections from the clients.
+        Private slot for new incoming connections from the clients.
 </p>
 <a NAME="BackgroundService.preferencesOrProjectChanged" ID="BackgroundService.preferencesOrProjectChanged"></a>
 <h4>BackgroundService.preferencesOrProjectChanged</h4>
@@ -299,13 +305,13 @@
 </p>
 <dl>
 
-<dt><i>fx</i></dt>
+<dt><i>fx</i> (str)</dt>
 <dd>
-function name of the service (str)
+function name of the service
 </dd>
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language to connect to (str)
+language to connect to
 </dd>
 </dl>
 <a NAME="BackgroundService.restartService" ID="BackgroundService.restartService"></a>
@@ -313,17 +319,17 @@
 <b>restartService</b>(<i>language, forceKill=False</i>)
 
 <p>
-        Public method to restart a given lanuage.
+        Public method to restart a given language.
 </p>
 <dl>
 
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-to restart (str)
+to restart
 </dd>
-<dt><i>forceKill</i></dt>
+<dt><i>forceKill</i> (bool)</dt>
 <dd>
-flag to kill a running task (bool)
+flag to kill a running task
 </dd>
 </dl>
 <a NAME="BackgroundService.serviceConnect" ID="BackgroundService.serviceConnect"></a>
@@ -336,34 +342,34 @@
 </p>
 <dl>
 
-<dt><i>fx</i></dt>
+<dt><i>fx</i> (str)</dt>
 <dd>
-function name of the service (str)
+function name of the service
 </dd>
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language of the new service (str)
+language of the new service
 </dd>
-<dt><i>modulepath</i></dt>
+<dt><i>modulepath</i> (str)</dt>
 <dd>
-full path to the module (str)
+full path to the module
 </dd>
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name to import (str)
+name to import
 </dd>
-<dt><i>callback</i></dt>
+<dt><i>callback</i> (function)</dt>
 <dd>
-function called on service response (function)
+function called on service response
 </dd>
 <dt><i>onErrorCallback</i></dt>
 <dd>
 function called, if client isn't available
             (function)
 </dd>
-<dt><i>onBatchDone</i></dt>
+<dt><i>onBatchDone</i> (function)</dt>
 <dd>
-function called when a batch job is done (function)
+function called when a batch job is done
 </dd>
 </dl>
 <a NAME="BackgroundService.serviceDisconnect" ID="BackgroundService.serviceDisconnect"></a>
@@ -375,13 +381,13 @@
 </p>
 <dl>
 
-<dt><i>fx</i></dt>
+<dt><i>fx</i> (function)</dt>
 <dd>
-function name of the service (function)
+function name of the service
 </dd>
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language of the service (str)
+language of the service
 </dd>
 </dl>
 <a NAME="BackgroundService.shutdown" ID="BackgroundService.shutdown"></a>

Mercurial Repository: eric

eric ide

mercurial