Sun, 14 Jan 2024 12:39:11 +0100
Log Viewer
- Added code to show an indicator for the log viewer icon, if new messages were added and the "Autoshow" option is deactivated.
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <!DOCTYPE html> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <html><head> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | <title>eric7.Utilities.BackgroundClient</title> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <meta charset="UTF-8"> |
8596
d64760b2da50
Documentation Generator: streamlined the code to use an external style sheet file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
8372
diff
changeset
|
5 | <link rel="stylesheet" href="styles.css"> |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | </head> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | <body> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | <a NAME="top" ID="top"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | <h1>eric7.Utilities.BackgroundClient</h1> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | Module implementing a Qt free version of a background client for the various |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | checkers and other python interpreter dependent functions. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
14 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | <h3>Global Attributes</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | <table> |
10478
de9106c55c3d
Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
17 | <tr><td>backgroundClient</td></tr> |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | </table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
19 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | <h3>Classes</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | <tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | <td><a href="#BackgroundClient">BackgroundClient</a></td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | <td>Class implementing the main part of the background client.</td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | </tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | </table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
27 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | <h3>Functions</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | <tr><td>None</td></tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | </table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
32 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | <hr /> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34 | <hr /> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | <a NAME="BackgroundClient" ID="BackgroundClient"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | <h2>BackgroundClient</h2> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | Class implementing the main part of the background client. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
40 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | <h3>Derived from</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | None |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | <h3>Class Attributes</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45 | <tr><td>None</td></tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | </table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
47 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | <h3>Class Methods</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | <tr><td>None</td></tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | </table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
52 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53 | <h3>Methods</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
55 | <tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
56 | <td><a href="#BackgroundClient.__init__">BackgroundClient</a></td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57 | <td>Constructor</td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | </tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59 | <tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60 | <td><a href="#BackgroundClient.__cancelled">__cancelled</a></td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61 | <td>Private method to check for a job cancellation.</td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62 | </tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | <tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
64 | <td><a href="#BackgroundClient.__initClientService">__initClientService</a></td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | <td>Private method to import the given module and register it as service.</td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | </tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | <tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68 | <td><a href="#BackgroundClient.__peek">__peek</a></td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
69 | <td>Private method to peek the given length of bytes.</td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
70 | </tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
71 | <tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72 | <td><a href="#BackgroundClient.__receive">__receive</a></td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
73 | <td>Private method to receive the given length of bytes.</td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74 | </tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
75 | <tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
76 | <td><a href="#BackgroundClient.__send">__send</a></td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
77 | <td>Private method to send a job response back to the BackgroundService server.</td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
78 | </tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
79 | <tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
80 | <td><a href="#BackgroundClient.run">run</a></td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
81 | <td>Public method implementing the main loop of the client.</td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
82 | </tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
83 | </table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
84 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
85 | <h3>Static Methods</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
86 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
87 | <tr><td>None</td></tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
88 | </table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
89 | |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
90 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
91 | <a NAME="BackgroundClient.__init__" ID="BackgroundClient.__init__"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
92 | <h4>BackgroundClient (Constructor)</h4> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
93 | <b>BackgroundClient</b>(<i>host, port, maxProcs</i>) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
94 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
95 | Constructor |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
96 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
97 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
98 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
99 | |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
100 | <dt><i>host</i> (str)</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
101 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
102 | ip address the background service is listening |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
103 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
104 | <dt><i>port</i> (int)</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
105 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
106 | port of the background service |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
107 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
108 | <dt><i>maxProcs</i> (int)</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
109 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
110 | maximum number of CPUs (processes) to use |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
111 | (0 = determined automatically) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
112 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
113 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
114 | <a NAME="BackgroundClient.__cancelled" ID="BackgroundClient.__cancelled"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
115 | <h4>BackgroundClient.__cancelled</h4> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
116 | <b>__cancelled</b>(<i></i>) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
117 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
118 | Private method to check for a job cancellation. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
119 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
120 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
121 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
122 | <dt>Return:</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
123 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
124 | flag indicating a cancellation |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
125 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
126 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
127 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
128 | <dt>Return Type:</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
129 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
130 | bool |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
131 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
132 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
133 | <a NAME="BackgroundClient.__initClientService" ID="BackgroundClient.__initClientService"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
134 | <h4>BackgroundClient.__initClientService</h4> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
135 | <b>__initClientService</b>(<i>fn, path, module</i>) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
136 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
137 | Private method to import the given module and register it as service. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
138 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
139 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
140 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
141 | |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
142 | <dt><i>fn</i> (str)</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
143 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
144 | service name to register |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
145 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
146 | <dt><i>path</i> (str)</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
147 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
148 | contains the path to the module |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
149 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
150 | <dt><i>module</i> (str)</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
151 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
152 | name to import |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
153 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
154 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
155 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
156 | <dt>Return:</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
157 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
158 | text result of the import action |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
159 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
160 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
161 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
162 | <dt>Return Type:</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
163 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
164 | str |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
165 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
166 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
167 | <a NAME="BackgroundClient.__peek" ID="BackgroundClient.__peek"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
168 | <h4>BackgroundClient.__peek</h4> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
169 | <b>__peek</b>(<i>length</i>) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
170 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
171 | Private method to peek the given length of bytes. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
172 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
173 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
174 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
175 | |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
176 | <dt><i>length</i> (int)</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
177 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
178 | bytes to receive |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
179 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
180 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
181 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
182 | <dt>Return:</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
183 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
184 | received bytes |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
185 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
186 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
187 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
188 | <dt>Return Type:</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
189 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
190 | bytes |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
191 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
192 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
193 | <a NAME="BackgroundClient.__receive" ID="BackgroundClient.__receive"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
194 | <h4>BackgroundClient.__receive</h4> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
195 | <b>__receive</b>(<i>length</i>) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
196 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
197 | Private method to receive the given length of bytes. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
198 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
199 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
200 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
201 | |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
202 | <dt><i>length</i> (int)</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
203 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
204 | bytes to receive |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
205 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
206 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
207 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
208 | <dt>Return:</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
209 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
210 | received bytes or None if connection closed |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
211 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
212 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
213 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
214 | <dt>Return Type:</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
215 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
216 | bytes |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
217 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
218 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
219 | <a NAME="BackgroundClient.__send" ID="BackgroundClient.__send"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
220 | <h4>BackgroundClient.__send</h4> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
221 | <b>__send</b>(<i>fx, fn, data</i>) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
222 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
223 | Private method to send a job response back to the BackgroundService |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
224 | server. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
225 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
226 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
227 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
228 | |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
229 | <dt><i>fx</i> (str)</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
230 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
231 | remote function name to execute |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
232 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
233 | <dt><i>fn</i> (str)</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
234 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
235 | filename for identification |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
236 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
237 | <dt><i>data</i> (any basic datatype)</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
238 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
239 | return value(s) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
240 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
241 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
242 | <a NAME="BackgroundClient.run" ID="BackgroundClient.run"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
243 | <h4>BackgroundClient.run</h4> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
244 | <b>run</b>(<i></i>) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
245 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
246 | Public method implementing the main loop of the client. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
247 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
248 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
249 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
250 | |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
251 | <dt>Raises <b>RuntimeError</b>:</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
252 | <dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
253 | raised if hashes don't match |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
254 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
255 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
256 | <div align="right"><a href="#top">Up</a></div> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
257 | <hr /> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10478
diff
changeset
|
258 | </body></html> |