--- a/src/eric7/Documentation/Source/eric7.Utilities.BackgroundClient.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.Utilities.BackgroundClient.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,54 +7,51 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.Utilities.BackgroundClient</h1> - <p> Module implementing a Qt free version of a background client for the various checkers and other python interpreter dependent functions. </p> + <h3>Global Attributes</h3> - <table> <tr><td>backgroundClient</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#BackgroundClient">BackgroundClient</a></td> <td>Class implementing the main part of the background client.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="BackgroundClient" ID="BackgroundClient"></a> <h2>BackgroundClient</h2> - <p> Class implementing the main part of the background client. </p> + <h3>Derived from</h3> None <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="#BackgroundClient.__init__">BackgroundClient</a></td> <td>Constructor</td> @@ -84,19 +81,20 @@ <td>Public method implementing the main loop of the client.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="BackgroundClient.__init__" ID="BackgroundClient.__init__"></a> <h4>BackgroundClient (Constructor)</h4> <b>BackgroundClient</b>(<i>host, port, maxProcs</i>) - <p> Constructor </p> + <dl> <dt><i>host</i> (str)</dt> @@ -116,10 +114,10 @@ <a NAME="BackgroundClient.__cancelled" ID="BackgroundClient.__cancelled"></a> <h4>BackgroundClient.__cancelled</h4> <b>__cancelled</b>(<i></i>) - <p> Private method to check for a job cancellation. </p> + <dl> <dt>Return:</dt> <dd> @@ -135,10 +133,10 @@ <a NAME="BackgroundClient.__initClientService" ID="BackgroundClient.__initClientService"></a> <h4>BackgroundClient.__initClientService</h4> <b>__initClientService</b>(<i>fn, path, module</i>) - <p> Private method to import the given module and register it as service. </p> + <dl> <dt><i>fn</i> (str)</dt> @@ -169,10 +167,10 @@ <a NAME="BackgroundClient.__peek" ID="BackgroundClient.__peek"></a> <h4>BackgroundClient.__peek</h4> <b>__peek</b>(<i>length</i>) - <p> Private method to peek the given length of bytes. </p> + <dl> <dt><i>length</i> (int)</dt> @@ -195,10 +193,10 @@ <a NAME="BackgroundClient.__receive" ID="BackgroundClient.__receive"></a> <h4>BackgroundClient.__receive</h4> <b>__receive</b>(<i>length</i>) - <p> Private method to receive the given length of bytes. </p> + <dl> <dt><i>length</i> (int)</dt> @@ -221,11 +219,11 @@ <a NAME="BackgroundClient.__send" ID="BackgroundClient.__send"></a> <h4>BackgroundClient.__send</h4> <b>__send</b>(<i>fx, fn, data</i>) - <p> Private method to send a job response back to the BackgroundService server. </p> + <dl> <dt><i>fx</i> (str)</dt> @@ -244,10 +242,10 @@ <a NAME="BackgroundClient.run" ID="BackgroundClient.run"></a> <h4>BackgroundClient.run</h4> <b>run</b>(<i></i>) - <p> Public method implementing the main loop of the client. </p> + <dl> <dt>Raises <b>RuntimeError</b>:</dt> @@ -257,4 +255,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>