eric6/Documentation/Source/eric6.Utilities.BackgroundClient.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7631
2c7ccb4484bf
--- a/eric6/Documentation/Source/eric6.Utilities.BackgroundClient.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.Utilities.BackgroundClient.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,169 +18,222 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.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>None</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 />
+<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>
 object
 <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 of the BackgroundClient class.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#BackgroundClient.__cancelled">__cancelled</a></td>
 <td>Private method to check for a job cancellation.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#BackgroundClient.__initClientService">__initClientService</a></td>
 <td>Private method to import the given module and register it as service.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#BackgroundClient.__peek">__peek</a></td>
 <td>Private methode to peek the given length of bytes.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#BackgroundClient.__receive">__receive</a></td>
 <td>Private methode to receive the given length of bytes.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#BackgroundClient.__send">__send</a></td>
 <td>Private method to send a job response back to the BackgroundService.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#BackgroundClient.run">run</a></td>
 <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 of the BackgroundClient class.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>host</i> (str)</dt>
 <dd>
 ip address the background service is listening
-</dd><dt><i>port</i> (int)</dt>
+</dd>
+<dt><i>port</i> (int)</dt>
 <dd>
 port of the background service
-</dd><dt><i>maxProcs</i> (int)</dt>
+</dd>
+<dt><i>maxProcs</i> (int)</dt>
 <dd>
 maximum number of CPUs (processes) to use
             (0 = determined automatically)
 </dd>
-</dl><a NAME="BackgroundClient.__cancelled" ID="BackgroundClient.__cancelled"></a>
+</dl>
+<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>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a cancellation (boolean)
 </dd>
-</dl><a NAME="BackgroundClient.__initClientService" ID="BackgroundClient.__initClientService"></a>
+</dl>
+<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>
+</p>
+<dl>
+
 <dt><i>fn</i></dt>
 <dd>
 service name to register (str)
-</dd><dt><i>path</i></dt>
+</dd>
+<dt><i>path</i></dt>
 <dd>
 contains the path to the module (str)
-</dd><dt><i>module</i></dt>
+</dd>
+<dt><i>module</i></dt>
 <dd>
 name to import (str)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 text result of the import action (str)
 </dd>
-</dl><a NAME="BackgroundClient.__peek" ID="BackgroundClient.__peek"></a>
+</dl>
+<a NAME="BackgroundClient.__peek" ID="BackgroundClient.__peek"></a>
 <h4>BackgroundClient.__peek</h4>
 <b>__peek</b>(<i>length</i>)
+
 <p>
         Private methode to peek the given length of bytes.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>length</i></dt>
 <dd>
 bytes to receive (int)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 received bytes (bytes)
 </dd>
-</dl><a NAME="BackgroundClient.__receive" ID="BackgroundClient.__receive"></a>
+</dl>
+<a NAME="BackgroundClient.__receive" ID="BackgroundClient.__receive"></a>
 <h4>BackgroundClient.__receive</h4>
 <b>__receive</b>(<i>length</i>)
+
 <p>
         Private methode to receive the given length of bytes.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>length</i></dt>
 <dd>
 bytes to receive (int)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 received bytes or None if connection closed (bytes)
 </dd>
-</dl><a NAME="BackgroundClient.__send" ID="BackgroundClient.__send"></a>
+</dl>
+<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.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>fx</i></dt>
 <dd>
 remote function name to execute (str)
-</dd><dt><i>fn</i></dt>
+</dd>
+<dt><i>fn</i></dt>
 <dd>
 filename for identification (str)
-</dd><dt><i>data</i></dt>
+</dd>
+<dt><i>data</i></dt>
 <dd>
 return value(s) (any basic datatype)
 </dd>
-</dl><a NAME="BackgroundClient.run" ID="BackgroundClient.run"></a>
+</dl>
+<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>

eric ide

mercurial