/usr/share/doc/python-scientific/Reference/Scientific.DistributedComputing.TaskManager.TaskManager-class.html is in python-scientific-doc 2.8-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Scientific.DistributedComputing.TaskManager.TaskManager</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Scientific-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://dirac.cnrs-orleans.fr/ScientificPython/">Scientific Python</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Scientific-module.html">Package Scientific</a> ::
<a href="Scientific.DistributedComputing-module.html">Package DistributedComputing</a> ::
<a href="Scientific.DistributedComputing.TaskManager-module.html">Module TaskManager</a> ::
Class TaskManager
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class TaskManager</h1><p class="nomargin-top"></p>
<pre class="base-tree">
Pyro.core.ObjBase --+
|
<strong class="uidshort">TaskManager</strong>
</pre>
<hr />
<p>Manager for computational tasks.</p>
<p>A TaskManager accepts task requests and hands them out to other
processes. It stores the results that can then be picked up by the
requester. A TaskManager also keeps track of its compute processes. If a
process disappears, its running tasks are re-scheduled for execution by
another compute process. TaskManangers are thread-safe.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>str</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#activeProcessInfo" class="summary-sig-name">activeProcessInfo</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">pid</span>)</span><br />
Returns:
information about the active process number pid</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>str</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#addTaskRequest" class="summary-sig-name">addTaskRequest</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tag</span>,
<span class="summary-sig-arg">parameters</span>,
<span class="summary-sig-arg">process_id</span>=<span class="summary-sig-default">None</span>)</span><br />
Returns:
the task id</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#deleteData" class="summary-sig-name">deleteData</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">label</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>tuple</code>
<p>Returns the result of an arbitrary finished task. The task is
removed from the list of finished tasks.</p></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#getAnyResult" class="summary-sig-name">getAnyResult</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns:
the task id, the task tag, and the result of the task</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>tuple</code>
<p>Returns a waiting task of arbitrary tag. The task is removed from
the list of waiting tasks and added to the list of running tasks.</p></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#getAnyTask" class="summary-sig-name">getAnyTask</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">process_id</span>=<span class="summary-sig-default">None</span>)</span><br />
Returns:
the task id, the task tag, and the parameters</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>tuple</code>
<p>Returns the result of a finished task that has the given tag. The
task is removed from the list of finished tasks.</p></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#getResultWithTag" class="summary-sig-name">getResultWithTag</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tag</span>)</span><br />
Returns:
the task id and the result of the task</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>tuple</code>
<p>Returns a waiting task with the given tag. The task is removed
from the list of waiting tasks and added to the list of running
tasks.</p></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#getTaskWithTag" class="summary-sig-name">getTaskWithTag</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tag</span>,
<span class="summary-sig-arg">process_id</span>=<span class="summary-sig-default">None</span>)</span><br />
Returns:
the task id and the parameters</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#numberOfActiveProcesses" class="summary-sig-name">numberOfActiveProcesses</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns:
the number of active processes</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>tuple</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#numberOfTasks" class="summary-sig-name">numberOfTasks</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns:
a tuple of dictionaries containing the number of waiting tasks, the
number of running tasks, and the number of results waiting to be
retrieved.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#ping" class="summary-sig-name">ping</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">process_id</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code>
<p>Registers a process with the task manager. All processes must call
this method before making any other task manager calls.</p></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#registerProcess" class="summary-sig-name">registerProcess</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">watchdog_period</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">info</span>=<span class="summary-sig-default">None</span>)</span><br />
Returns:
a unique process id</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#retrieveData" class="summary-sig-name">retrieveData</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">label</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#returnTask" class="summary-sig-name">returnTask</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">task_id</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#storeData" class="summary-sig-name">storeData</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**kw</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#storeException" class="summary-sig-name">storeException</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">task_id</span>,
<span class="summary-sig-arg">exception</span>,
<span class="summary-sig-arg">traceback</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#storeResult" class="summary-sig-name">storeResult</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">task_id</span>,
<span class="summary-sig-arg">result</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#terminate" class="summary-sig-name">terminate</a>(<span class="summary-sig-arg">self</span>)</span><br />
Signals that no more tasks or results will be requested.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.DistributedComputing.TaskManager.TaskManager-class.html#unregisterProcess" class="summary-sig-name">unregisterProcess</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">process_id</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>Pyro.core.ObjBase</code></b>:
<code>GUID</code>,
<code>Pyro_dyncall</code>,
<code>delegateTo</code>,
<code>getAttrProxy</code>,
<code>getDaemon</code>,
<code>getLocalStorage</code>,
<code>getProxy</code>,
<code>remote_retrieve_code</code>,
<code>remote_supply_code</code>,
<code>setCodeValidator</code>,
<code>setDaemon</code>,
<code>setGUID</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
Pyro.core.ObjBase.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="activeProcessInfo"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">activeProcessInfo</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">pid</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>pid</code></strong> (<code>int</code>) - the number of an active process</li>
</ul></dd>
<dt>Returns: <code>str</code></dt>
<dd>information about the active process number pid</dd>
</dl>
</td></tr></table>
</div>
<a name="addTaskRequest"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addTaskRequest</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">tag</span>,
<span class="sig-arg">parameters</span>,
<span class="sig-arg">process_id</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>tag</code></strong> (<code>str</code>) - the tag of the task being requested</li>
<li><strong class="pname"><code>parameters</code></strong> - the parameters to be passed to the task</li>
<li><strong class="pname"><code>process_id</code></strong> (<code>int</code>) - the id of the requesting process (optional)</li>
</ul></dd>
<dt>Returns: <code>str</code></dt>
<dd>the task id</dd>
</dl>
</td></tr></table>
</div>
<a name="deleteData"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">deleteData</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">label</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>label</code></strong> (<code>str</code>) - the label of the data item to be deleted</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getAnyResult"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getAnyResult</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Returns: <code>tuple</code>
<p>Returns the result of an arbitrary finished task. The task is
removed from the list of finished tasks.</p></dt>
<dd>the task id, the task tag, and the result of the task</dd>
</dl>
</td></tr></table>
</div>
<a name="getAnyTask"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getAnyTask</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">process_id</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>process_id</code></strong> (<code>int</code>) - the id of the retrieving process (optional)</li>
</ul></dd>
<dt>Returns: <code>tuple</code>
<p>Returns a waiting task of arbitrary tag. The task is removed from
the list of waiting tasks and added to the list of running tasks.</p></dt>
<dd>the task id, the task tag, and the parameters</dd>
</dl>
</td></tr></table>
</div>
<a name="getResultWithTag"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getResultWithTag</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">tag</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>tag</code></strong> - a task tag</li>
</ul></dd>
<dt>Returns: <code>tuple</code>
<p>Returns the result of a finished task that has the given tag. The
task is removed from the list of finished tasks.</p></dt>
<dd>the task id and the result of the task</dd>
</dl>
</td></tr></table>
</div>
<a name="getTaskWithTag"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getTaskWithTag</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">tag</span>,
<span class="sig-arg">process_id</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>tag</code></strong> (<code>str</code>) - a task tag</li>
<li><strong class="pname"><code>process_id</code></strong> (<code>int</code>) - the id of the retrieving process (optional)</li>
</ul></dd>
<dt>Returns: <code>tuple</code>
<p>Returns a waiting task with the given tag. The task is removed
from the list of waiting tasks and added to the list of running
tasks.</p></dt>
<dd>the task id and the parameters</dd>
</dl>
</td></tr></table>
</div>
<a name="numberOfActiveProcesses"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">numberOfActiveProcesses</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Returns: <code>int</code></dt>
<dd>the number of active processes</dd>
</dl>
</td></tr></table>
</div>
<a name="numberOfTasks"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">numberOfTasks</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Returns: <code>tuple</code></dt>
<dd>a tuple of dictionaries containing the number of waiting tasks,
the number of running tasks, and the number of results waiting to
be retrieved. Each dictionary contains the count for each tag.</dd>
</dl>
</td></tr></table>
</div>
<a name="ping"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">ping</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">process_id</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>process_id</code></strong> (<code>int</code>
<p>Tells the task manager that a process is still alive.</p>) - the id of the process</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="registerProcess"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">registerProcess</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">watchdog_period</span>=<span class="sig-default">None</span>,
<span class="sig-arg">info</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>watchdog_period</code></strong> (<code>int</code> or <code>NoneType</code>) - the period at which the registering process promises to ping the
task manager to signal that is still alive. If <code>None</code>,
no pings are expected.</li>
<li><strong class="pname"><code>info</code></strong> (<code>str</code>) - an information string telling something about the machine running
the process</li>
</ul></dd>
<dt>Returns: <code>int</code>
<p>Registers a process with the task manager. All processes must call
this method before making any other task manager calls.</p></dt>
<dd>a unique process id</dd>
</dl>
</td></tr></table>
</div>
<a name="retrieveData"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">retrieveData</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">label</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>label</code></strong> (<code>str</code>) - the label of the data item to be retrieved</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="returnTask"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">returnTask</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">task_id</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>task_id</code></strong> (<code>str</code>
<p>Removes a task from the list of running tasks and put its back
at the beginning of the list of waiting tasks. This method should
be called by a process that has obtained a task but cannot handle
it.</p>) - the id of the task for which the result is provided</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="storeData"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">storeData</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**kw</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>kw</code></strong> (<code>dict</code>
<p>This routine permits processes to exchange arbitrary data
items through the task manager.</p>) - a keyword list of data items to be stored</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="storeException"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">storeException</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">task_id</span>,
<span class="sig-arg">exception</span>,
<span class="sig-arg">traceback</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>task_id</code></strong> (<code>str</code>) - the id of the task for which the result is provided</li>
<li><strong class="pname"><code>exception</code></strong> - the exception raised by the task</li>
<li><strong class="pname"><code>traceback</code></strong> (<code>str</code>
<p>Stores the exception associated with the task. The task is
removed from the list of running tasks and added to the list of
finished tasks. When the result is retrieved by another process,
<a
href="Scientific.DistributedComputing.TaskManager.TaskRaisedException-class.html"
class="link">TaskRaisedException</a> is raised.</p>) - a text version of the stack traceback at the time of the
exception</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="storeResult"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">storeResult</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">task_id</span>,
<span class="sig-arg">result</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>task_id</code></strong> (<code>str</code>) - the id of the task for which the result is provided</li>
<li><strong class="pname"><code>result</code></strong> - the result of the task
<p>Stores the result associated with the task. The task is
removed from the list of running tasks and added to the list of
finished tasks.</p></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="terminate"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">terminate</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Signals that no more tasks or results will be requested. All waiting
threads will be terminated by raising <a
href="Scientific.DistributedComputing.TaskManager.TaskManagerTermination-class.html"
class="link">TaskManagerTermination</a>.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="unregisterProcess"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">unregisterProcess</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">process_id</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>process_id</code></strong> (<code>int</code>
<p>Removes the process from the task manager's process list. All
processes should unregister when they are no longer available for
accepting tasks. The task manager will also unregister processes
itself if they do not ping the task manager at the promised
frequency.</p>) - the id of the process</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Scientific-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://dirac.cnrs-orleans.fr/ScientificPython/">Scientific Python</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0 on Tue Oct 28 14:16:03 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|