7991:866adc8c315b | 8043:0acf98cd089a |
---|---|
103 <tr> | 103 <tr> |
104 <td><a href="#HgClient.func">func</a></td> | 104 <td><a href="#HgClient.func">func</a></td> |
105 <td></td> | 105 <td></td> |
106 </tr> | 106 </tr> |
107 <tr> | 107 <tr> |
108 <td><a href="#HgClient.getRepository">getRepository</a></td> | |
109 <td>Public method to get the repository path this client is serving.</td> | |
110 </tr> | |
111 <tr> | |
108 <td><a href="#HgClient.isExecuting">isExecuting</a></td> | 112 <td><a href="#HgClient.isExecuting">isExecuting</a></td> |
109 <td>Public method to check, if the server is executing a command.</td> | 113 <td>Public method to check, if the server is executing a command.</td> |
110 </tr> | 114 </tr> |
111 <tr> | 115 <tr> |
112 <td><a href="#HgClient.myprompt">myprompt</a></td> | 116 <td><a href="#HgClient.myprompt">myprompt</a></td> |
182 <dd> | 186 <dd> |
183 message sent by the server | 187 message sent by the server |
184 </dd> | 188 </dd> |
185 </dl> | 189 </dl> |
186 <dl> | 190 <dl> |
187 <dt>Returns:</dt> | 191 <dt>Return:</dt> |
188 <dd> | 192 <dd> |
189 tuple containing data entered by the user and | 193 tuple containing data entered by the user and |
190 a flag indicating a password input | 194 a flag indicating a password input |
191 </dd> | 195 </dd> |
192 </dl> | 196 </dl> |
202 | 206 |
203 <p> | 207 <p> |
204 Private method to read data from the command server. | 208 Private method to read data from the command server. |
205 </p> | 209 </p> |
206 <dl> | 210 <dl> |
207 <dt>Returns:</dt> | 211 <dt>Return:</dt> |
208 <dd> | 212 <dd> |
209 tuple of channel designator and channel data | 213 tuple of channel designator and channel data |
210 </dd> | 214 </dd> |
211 </dl> | 215 </dl> |
212 <dl> | 216 <dl> |
221 | 225 |
222 <p> | 226 <p> |
223 Private method to read the hello message sent by the command server. | 227 Private method to read the hello message sent by the command server. |
224 </p> | 228 </p> |
225 <dl> | 229 <dl> |
226 <dt>Returns:</dt> | 230 <dt>Return:</dt> |
227 <dd> | 231 <dd> |
228 tuple of flag indicating success and an error message in case | 232 tuple of flag indicating success and an error message in case |
229 of failure | 233 of failure |
230 </dd> | 234 </dd> |
231 </dl> | 235 </dl> |
260 must have the keys 'o' and 'e' and each entry must be a function | 264 must have the keys 'o' and 'e' and each entry must be a function |
261 receiving the data. | 265 receiving the data. |
262 </dd> | 266 </dd> |
263 </dl> | 267 </dl> |
264 <dl> | 268 <dl> |
265 <dt>Returns:</dt> | 269 <dt>Return:</dt> |
266 <dd> | 270 <dd> |
267 result code of the command, -1 if the command server wasn't | 271 result code of the command, -1 if the command server wasn't |
268 started or -10, if the command was canceled | 272 started or -10, if the command was canceled |
269 </dd> | 273 </dd> |
270 </dl> | 274 </dl> |
323 </p> | 327 </p> |
324 <a NAME="HgClient.func" ID="HgClient.func"></a> | 328 <a NAME="HgClient.func" ID="HgClient.func"></a> |
325 <h4>HgClient.func</h4> | 329 <h4>HgClient.func</h4> |
326 <b>func</b>(<i></i>) | 330 <b>func</b>(<i></i>) |
327 | 331 |
332 <a NAME="HgClient.getRepository" ID="HgClient.getRepository"></a> | |
333 <h4>HgClient.getRepository</h4> | |
334 <b>getRepository</b>(<i></i>) | |
335 | |
336 <p> | |
337 Public method to get the repository path this client is serving. | |
338 </p> | |
339 <dl> | |
340 <dt>Return:</dt> | |
341 <dd> | |
342 repository path | |
343 </dd> | |
344 </dl> | |
345 <dl> | |
346 <dt>Return Type:</dt> | |
347 <dd> | |
348 str | |
349 </dd> | |
350 </dl> | |
328 <a NAME="HgClient.isExecuting" ID="HgClient.isExecuting"></a> | 351 <a NAME="HgClient.isExecuting" ID="HgClient.isExecuting"></a> |
329 <h4>HgClient.isExecuting</h4> | 352 <h4>HgClient.isExecuting</h4> |
330 <b>isExecuting</b>(<i></i>) | 353 <b>isExecuting</b>(<i></i>) |
331 | 354 |
332 <p> | 355 <p> |
333 Public method to check, if the server is executing a command. | 356 Public method to check, if the server is executing a command. |
334 </p> | 357 </p> |
335 <dl> | 358 <dl> |
336 <dt>Returns:</dt> | 359 <dt>Return:</dt> |
337 <dd> | 360 <dd> |
338 flag indicating the execution of a command | 361 flag indicating the execution of a command |
339 </dd> | 362 </dd> |
340 </dl> | 363 </dl> |
341 <dl> | 364 <dl> |
354 | 377 |
355 <p> | 378 <p> |
356 Public method to restart the command server. | 379 Public method to restart the command server. |
357 </p> | 380 </p> |
358 <dl> | 381 <dl> |
359 <dt>Returns:</dt> | 382 <dt>Return:</dt> |
360 <dd> | 383 <dd> |
361 tuple of flag indicating a successful start and an error | 384 tuple of flag indicating a successful start and an error |
362 message in case of failure | 385 message in case of failure |
363 </dd> | 386 </dd> |
364 </dl> | 387 </dl> |
405 <dd> | 428 <dd> |
406 function receiving error messages from the server | 429 function receiving error messages from the server |
407 </dd> | 430 </dd> |
408 </dl> | 431 </dl> |
409 <dl> | 432 <dl> |
410 <dt>Returns:</dt> | 433 <dt>Return:</dt> |
411 <dd> | 434 <dd> |
412 tuple of output and errors of the command server. In case | 435 tuple of output and errors of the command server. In case |
413 output and/or error functions were given, the respective return | 436 output and/or error functions were given, the respective return |
414 value will be an empty string. | 437 value will be an empty string. |
415 </dd> | 438 </dd> |
426 | 449 |
427 <p> | 450 <p> |
428 Public method to start the command server. | 451 Public method to start the command server. |
429 </p> | 452 </p> |
430 <dl> | 453 <dl> |
431 <dt>Returns:</dt> | 454 <dt>Return:</dt> |
432 <dd> | 455 <dd> |
433 tuple of flag indicating a successful start and an error | 456 tuple of flag indicating a successful start and an error |
434 message in case of failure | 457 message in case of failure |
435 </dd> | 458 </dd> |
436 </dl> | 459 </dl> |
453 | 476 |
454 <p> | 477 <p> |
455 Public method to check, if the last command was canceled. | 478 Public method to check, if the last command was canceled. |
456 </p> | 479 </p> |
457 <dl> | 480 <dl> |
458 <dt>Returns:</dt> | 481 <dt>Return:</dt> |
459 <dd> | 482 <dd> |
460 flag indicating the cancel state | 483 flag indicating the cancel state |
461 </dd> | 484 </dd> |
462 </dl> | 485 </dl> |
463 <dl> | 486 <dl> |