Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Utilities.BackgroundClient.html
eric6/Documentation/Source/eric6.Utilities.BackgroundClient.html
- changeset 7965
- 48fbf9149d16
- parent 7631
- 2c7ccb4484bf
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7963:19bbd56ac5f2 | 7965:48fbf9149d16 |
|---|---|
| 69 | 69 |
| 70 <table> | 70 <table> |
| 71 | 71 |
| 72 <tr> | 72 <tr> |
| 73 <td><a href="#BackgroundClient.__init__">BackgroundClient</a></td> | 73 <td><a href="#BackgroundClient.__init__">BackgroundClient</a></td> |
| 74 <td>Constructor of the BackgroundClient class.</td> | 74 <td>Constructor</td> |
| 75 </tr> | 75 </tr> |
| 76 <tr> | 76 <tr> |
| 77 <td><a href="#BackgroundClient.__cancelled">__cancelled</a></td> | 77 <td><a href="#BackgroundClient.__cancelled">__cancelled</a></td> |
| 78 <td>Private method to check for a job cancellation.</td> | 78 <td>Private method to check for a job cancellation.</td> |
| 79 </tr> | 79 </tr> |
| 81 <td><a href="#BackgroundClient.__initClientService">__initClientService</a></td> | 81 <td><a href="#BackgroundClient.__initClientService">__initClientService</a></td> |
| 82 <td>Private method to import the given module and register it as service.</td> | 82 <td>Private method to import the given module and register it as service.</td> |
| 83 </tr> | 83 </tr> |
| 84 <tr> | 84 <tr> |
| 85 <td><a href="#BackgroundClient.__peek">__peek</a></td> | 85 <td><a href="#BackgroundClient.__peek">__peek</a></td> |
| 86 <td>Private methode to peek the given length of bytes.</td> | 86 <td>Private method to peek the given length of bytes.</td> |
| 87 </tr> | 87 </tr> |
| 88 <tr> | 88 <tr> |
| 89 <td><a href="#BackgroundClient.__receive">__receive</a></td> | 89 <td><a href="#BackgroundClient.__receive">__receive</a></td> |
| 90 <td>Private methode to receive the given length of bytes.</td> | 90 <td>Private method to receive the given length of bytes.</td> |
| 91 </tr> | 91 </tr> |
| 92 <tr> | 92 <tr> |
| 93 <td><a href="#BackgroundClient.__send">__send</a></td> | 93 <td><a href="#BackgroundClient.__send">__send</a></td> |
| 94 <td>Private method to send a job response back to the BackgroundService.</td> | 94 <td>Private method to send a job response back to the BackgroundService server.</td> |
| 95 </tr> | 95 </tr> |
| 96 <tr> | 96 <tr> |
| 97 <td><a href="#BackgroundClient.run">run</a></td> | 97 <td><a href="#BackgroundClient.run">run</a></td> |
| 98 <td>Public method implementing the main loop of the client.</td> | 98 <td>Public method implementing the main loop of the client.</td> |
| 99 </tr> | 99 </tr> |
| 107 <a NAME="BackgroundClient.__init__" ID="BackgroundClient.__init__"></a> | 107 <a NAME="BackgroundClient.__init__" ID="BackgroundClient.__init__"></a> |
| 108 <h4>BackgroundClient (Constructor)</h4> | 108 <h4>BackgroundClient (Constructor)</h4> |
| 109 <b>BackgroundClient</b>(<i>host, port, maxProcs</i>) | 109 <b>BackgroundClient</b>(<i>host, port, maxProcs</i>) |
| 110 | 110 |
| 111 <p> | 111 <p> |
| 112 Constructor of the BackgroundClient class. | 112 Constructor |
| 113 </p> | 113 </p> |
| 114 <dl> | 114 <dl> |
| 115 | 115 |
| 116 <dt><i>host</i> (str)</dt> | 116 <dt><i>host</i> (str)</dt> |
| 117 <dd> | 117 <dd> |
| 135 Private method to check for a job cancellation. | 135 Private method to check for a job cancellation. |
| 136 </p> | 136 </p> |
| 137 <dl> | 137 <dl> |
| 138 <dt>Returns:</dt> | 138 <dt>Returns:</dt> |
| 139 <dd> | 139 <dd> |
| 140 flag indicating a cancellation (boolean) | 140 flag indicating a cancellation |
| 141 </dd> | |
| 142 </dl> | |
| 143 <dl> | |
| 144 <dt>Return Type:</dt> | |
| 145 <dd> | |
| 146 bool | |
| 141 </dd> | 147 </dd> |
| 142 </dl> | 148 </dl> |
| 143 <a NAME="BackgroundClient.__initClientService" ID="BackgroundClient.__initClientService"></a> | 149 <a NAME="BackgroundClient.__initClientService" ID="BackgroundClient.__initClientService"></a> |
| 144 <h4>BackgroundClient.__initClientService</h4> | 150 <h4>BackgroundClient.__initClientService</h4> |
| 145 <b>__initClientService</b>(<i>fn, path, module</i>) | 151 <b>__initClientService</b>(<i>fn, path, module</i>) |
| 147 <p> | 153 <p> |
| 148 Private method to import the given module and register it as service. | 154 Private method to import the given module and register it as service. |
| 149 </p> | 155 </p> |
| 150 <dl> | 156 <dl> |
| 151 | 157 |
| 152 <dt><i>fn</i></dt> | 158 <dt><i>fn</i> (str)</dt> |
| 153 <dd> | 159 <dd> |
| 154 service name to register (str) | 160 service name to register |
| 155 </dd> | 161 </dd> |
| 156 <dt><i>path</i></dt> | 162 <dt><i>path</i> (str)</dt> |
| 157 <dd> | 163 <dd> |
| 158 contains the path to the module (str) | 164 contains the path to the module |
| 159 </dd> | 165 </dd> |
| 160 <dt><i>module</i></dt> | 166 <dt><i>module</i> (str)</dt> |
| 161 <dd> | 167 <dd> |
| 162 name to import (str) | 168 name to import |
| 163 </dd> | 169 </dd> |
| 164 </dl> | 170 </dl> |
| 165 <dl> | 171 <dl> |
| 166 <dt>Returns:</dt> | 172 <dt>Returns:</dt> |
| 167 <dd> | 173 <dd> |
| 168 text result of the import action (str) | 174 text result of the import action |
| 175 </dd> | |
| 176 </dl> | |
| 177 <dl> | |
| 178 <dt>Return Type:</dt> | |
| 179 <dd> | |
| 180 str | |
| 169 </dd> | 181 </dd> |
| 170 </dl> | 182 </dl> |
| 171 <a NAME="BackgroundClient.__peek" ID="BackgroundClient.__peek"></a> | 183 <a NAME="BackgroundClient.__peek" ID="BackgroundClient.__peek"></a> |
| 172 <h4>BackgroundClient.__peek</h4> | 184 <h4>BackgroundClient.__peek</h4> |
| 173 <b>__peek</b>(<i>length</i>) | 185 <b>__peek</b>(<i>length</i>) |
| 174 | 186 |
| 175 <p> | 187 <p> |
| 176 Private methode to peek the given length of bytes. | 188 Private method to peek the given length of bytes. |
| 177 </p> | 189 </p> |
| 178 <dl> | 190 <dl> |
| 179 | 191 |
| 180 <dt><i>length</i></dt> | 192 <dt><i>length</i> (int)</dt> |
| 181 <dd> | 193 <dd> |
| 182 bytes to receive (int) | 194 bytes to receive |
| 183 </dd> | 195 </dd> |
| 184 </dl> | 196 </dl> |
| 185 <dl> | 197 <dl> |
| 186 <dt>Returns:</dt> | 198 <dt>Returns:</dt> |
| 187 <dd> | 199 <dd> |
| 188 received bytes (bytes) | 200 received bytes |
| 201 </dd> | |
| 202 </dl> | |
| 203 <dl> | |
| 204 <dt>Return Type:</dt> | |
| 205 <dd> | |
| 206 bytes | |
| 189 </dd> | 207 </dd> |
| 190 </dl> | 208 </dl> |
| 191 <a NAME="BackgroundClient.__receive" ID="BackgroundClient.__receive"></a> | 209 <a NAME="BackgroundClient.__receive" ID="BackgroundClient.__receive"></a> |
| 192 <h4>BackgroundClient.__receive</h4> | 210 <h4>BackgroundClient.__receive</h4> |
| 193 <b>__receive</b>(<i>length</i>) | 211 <b>__receive</b>(<i>length</i>) |
| 194 | 212 |
| 195 <p> | 213 <p> |
| 196 Private methode to receive the given length of bytes. | 214 Private method to receive the given length of bytes. |
| 197 </p> | 215 </p> |
| 198 <dl> | 216 <dl> |
| 199 | 217 |
| 200 <dt><i>length</i></dt> | 218 <dt><i>length</i> (int)</dt> |
| 201 <dd> | 219 <dd> |
| 202 bytes to receive (int) | 220 bytes to receive |
| 203 </dd> | 221 </dd> |
| 204 </dl> | 222 </dl> |
| 205 <dl> | 223 <dl> |
| 206 <dt>Returns:</dt> | 224 <dt>Returns:</dt> |
| 207 <dd> | 225 <dd> |
| 208 received bytes or None if connection closed (bytes) | 226 received bytes or None if connection closed |
| 227 </dd> | |
| 228 </dl> | |
| 229 <dl> | |
| 230 <dt>Return Type:</dt> | |
| 231 <dd> | |
| 232 bytes | |
| 209 </dd> | 233 </dd> |
| 210 </dl> | 234 </dl> |
| 211 <a NAME="BackgroundClient.__send" ID="BackgroundClient.__send"></a> | 235 <a NAME="BackgroundClient.__send" ID="BackgroundClient.__send"></a> |
| 212 <h4>BackgroundClient.__send</h4> | 236 <h4>BackgroundClient.__send</h4> |
| 213 <b>__send</b>(<i>fx, fn, data</i>) | 237 <b>__send</b>(<i>fx, fn, data</i>) |
| 214 | 238 |
| 215 <p> | 239 <p> |
| 216 Private method to send a job response back to the BackgroundService. | 240 Private method to send a job response back to the BackgroundService |
| 217 </p> | 241 server. |
| 218 <dl> | 242 </p> |
| 219 | 243 <dl> |
| 220 <dt><i>fx</i></dt> | 244 |
| 221 <dd> | 245 <dt><i>fx</i> (str)</dt> |
| 222 remote function name to execute (str) | 246 <dd> |
| 223 </dd> | 247 remote function name to execute |
| 224 <dt><i>fn</i></dt> | 248 </dd> |
| 225 <dd> | 249 <dt><i>fn</i> (str)</dt> |
| 226 filename for identification (str) | 250 <dd> |
| 227 </dd> | 251 filename for identification |
| 228 <dt><i>data</i></dt> | 252 </dd> |
| 229 <dd> | 253 <dt><i>data</i> (any basic datatype)</dt> |
| 230 return value(s) (any basic datatype) | 254 <dd> |
| 255 return value(s) | |
| 231 </dd> | 256 </dd> |
| 232 </dl> | 257 </dl> |
| 233 <a NAME="BackgroundClient.run" ID="BackgroundClient.run"></a> | 258 <a NAME="BackgroundClient.run" ID="BackgroundClient.run"></a> |
| 234 <h4>BackgroundClient.run</h4> | 259 <h4>BackgroundClient.run</h4> |
| 235 <b>run</b>(<i></i>) | 260 <b>run</b>(<i></i>) |
