--- a/src/eric7/Documentation/Source/eric7.Utilities.BackgroundService.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Utilities.BackgroundService.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,38 +7,37 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Utilities.BackgroundService</h1>
-
<p>
Module implementing a background service for the various checkers and other
Python interpreter dependent functions.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#BackgroundService">BackgroundService</a></td>
<td>Class implementing the main part of the background service.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="BackgroundService" ID="BackgroundService"></a>
<h2>BackgroundService</h2>
-
<p>
Class implementing the main part of the background service.
</p>
+
<h3>Signals</h3>
<dl>
@@ -56,19 +55,17 @@
<h3>Derived from</h3>
QTcpServer
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#BackgroundService.__init__">BackgroundService</a></td>
<td>Constructor</td>
@@ -130,19 +127,20 @@
<td>Public method to cleanup the connections and processes when eric is shutting down.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="BackgroundService.__init__" ID="BackgroundService.__init__"></a>
<h4>BackgroundService (Constructor)</h4>
<b>BackgroundService</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QObject)</dt>
@@ -153,11 +151,11 @@
<a NAME="BackgroundService.__getPythonInterpreter" ID="BackgroundService.__getPythonInterpreter"></a>
<h4>BackgroundService.__getPythonInterpreter</h4>
<b>__getPythonInterpreter</b>(<i></i>)
-
<p>
Private method to generate the path of the Python interpreter to be
used to run the background client.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -173,18 +171,18 @@
<a NAME="BackgroundService.__processQueue" ID="BackgroundService.__processQueue"></a>
<h4>BackgroundService.__processQueue</h4>
<b>__processQueue</b>(<i></i>)
-
<p>
Private method to take the next service request and send it to the
client.
</p>
+
<a NAME="BackgroundService.__receive" ID="BackgroundService.__receive"></a>
<h4>BackgroundService.__receive</h4>
<b>__receive</b>(<i>lang</i>)
-
<p>
Private method to receive the response from the clients.
</p>
+
<dl>
<dt><i>lang</i> (str)</dt>
@@ -202,10 +200,10 @@
<a NAME="BackgroundService.__send" ID="BackgroundService.__send"></a>
<h4>BackgroundService.__send</h4>
<b>__send</b>(<i>fx, lang, fn, data</i>)
-
<p>
Private method to send a job request to one of the clients.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -228,10 +226,10 @@
<a NAME="BackgroundService.__startExternalClient" ID="BackgroundService.__startExternalClient"></a>
<h4>BackgroundService.__startExternalClient</h4>
<b>__startExternalClient</b>(<i>interpreter, port</i>)
-
<p>
Private method to start the background client as external process.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -258,7 +256,6 @@
<a NAME="BackgroundService.enqueueRequest" ID="BackgroundService.enqueueRequest"></a>
<h4>BackgroundService.enqueueRequest</h4>
<b>enqueueRequest</b>(<i>fx, lang, fn, data</i>)
-
<p>
Public method implementing a queued processing of incoming events.
</p>
@@ -266,6 +263,7 @@
Duplicate service requests update an older request to avoid overrun or
starving of the services.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -288,10 +286,10 @@
<a NAME="BackgroundService.on_disconnectSocket" ID="BackgroundService.on_disconnectSocket"></a>
<h4>BackgroundService.on_disconnectSocket</h4>
<b>on_disconnectSocket</b>(<i>lang</i>)
-
<p>
Private slot called when connection to a client is lost.
</p>
+
<dl>
<dt><i>lang</i> (str)</dt>
@@ -302,24 +300,24 @@
<a NAME="BackgroundService.on_newConnection" ID="BackgroundService.on_newConnection"></a>
<h4>BackgroundService.on_newConnection</h4>
<b>on_newConnection</b>(<i></i>)
-
<p>
Private slot for new incoming connections from the clients.
</p>
+
<a NAME="BackgroundService.preferencesOrProjectChanged" ID="BackgroundService.preferencesOrProjectChanged"></a>
<h4>BackgroundService.preferencesOrProjectChanged</h4>
<b>preferencesOrProjectChanged</b>(<i></i>)
-
<p>
Public slot to restart the built in languages.
</p>
+
<a NAME="BackgroundService.requestCancel" ID="BackgroundService.requestCancel"></a>
<h4>BackgroundService.requestCancel</h4>
<b>requestCancel</b>(<i>fx, lang</i>)
-
<p>
Public method to ask a batch job to terminate.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -334,10 +332,10 @@
<a NAME="BackgroundService.restartService" ID="BackgroundService.restartService"></a>
<h4>BackgroundService.restartService</h4>
<b>restartService</b>(<i>language, forceKill=False</i>)
-
<p>
Public method to restart a given language.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -352,11 +350,11 @@
<a NAME="BackgroundService.serviceConnect" ID="BackgroundService.serviceConnect"></a>
<h4>BackgroundService.serviceConnect</h4>
<b>serviceConnect</b>(<i>fx, lang, modulepath, module, callback, onErrorCallback=None, onBatchDone=None, </i>)
-
<p>
Public method to announce a new service to the background
service/client.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -391,10 +389,10 @@
<a NAME="BackgroundService.serviceDisconnect" ID="BackgroundService.serviceDisconnect"></a>
<h4>BackgroundService.serviceDisconnect</h4>
<b>serviceDisconnect</b>(<i>fx, lang</i>)
-
<p>
Public method to remove the service from the service list.
</p>
+
<dl>
<dt><i>fx</i> (function)</dt>
@@ -409,11 +407,11 @@
<a NAME="BackgroundService.shutdown" ID="BackgroundService.shutdown"></a>
<h4>BackgroundService.shutdown</h4>
<b>shutdown</b>(<i></i>)
-
<p>
Public method to cleanup the connections and processes when eric is
shutting down.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
