--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Utilities.BackgroundClient.html Wed Jan 15 22:55:52 2014 +0100
@@ -0,0 +1,155 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric5.Utilities.BackgroundClient</title>
+<meta charset="UTF-8">
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.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 />
+<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>backgroundClient</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>
+<td><a href="#BackgroundClient.__initClientService">__initClientService</a></td>
+<td>Import the given module and register it as service.</td>
+</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>
+<td><a href="#BackgroundClient.__unhandled_exception">__unhandled_exception</a></td>
+<td>Private method called to report an uncaught exception.</td>
+</tr><tr>
+<td><a href="#BackgroundClient.run">run</a></td>
+<td>Implement 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</i>)
+<p>
+ Constructor of the BackgroundClient class.
+</p><dl>
+<dt><i>host</i></dt>
+<dd>
+ip address the background service is listening
+</dd><dt><i>port</i></dt>
+<dd>
+port of the background service
+</dd>
+</dl><a NAME="BackgroundClient.__initClientService" ID="BackgroundClient.__initClientService"></a>
+<h4>BackgroundClient.__initClientService</h4>
+<b>__initClientService</b>(<i>fn, path, module</i>)
+<p>
+ Import the given module and register it as service.
+</p><dl>
+<dt><i>fn</i></dt>
+<dd>
+service name to register (str)
+</dd><dt><i>path</i></dt>
+<dd>
+contains the path to the module (str)
+</dd><dt><i>module</i></dt>
+<dd>
+name to import (str)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+text result of the import action (str)
+</dd>
+</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>
+<dt><i>fx</i></dt>
+<dd>
+remote function name to execute (str)
+</dd><dt><i>fn</i></dt>
+<dd>
+filename for identification (str)
+</dd><dt><i>data</i></dt>
+<dd>
+return value(s) (any basic datatype)
+</dd>
+</dl><a NAME="BackgroundClient.__unhandled_exception" ID="BackgroundClient.__unhandled_exception"></a>
+<h4>BackgroundClient.__unhandled_exception</h4>
+<b>__unhandled_exception</b>(<i>exctype, excval, exctb</i>)
+<p>
+ Private method called to report an uncaught exception.
+</p><dl>
+<dt><i>exctype</i></dt>
+<dd>
+the type of the exception
+</dd><dt><i>excval</i></dt>
+<dd>
+data about the exception
+</dd><dt><i>exctb</i></dt>
+<dd>
+traceback for the exception
+</dd>
+</dl><a NAME="BackgroundClient.run" ID="BackgroundClient.run"></a>
+<h4>BackgroundClient.run</h4>
+<b>run</b>(<i></i>)
+<p>
+ Implement the main loop of the client.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
