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 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Concurrent::Cancellation
— Concurrent Ruby
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Concurrent::Cancellation";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (C)</a> »
<span class='title'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span>
»
<span class="title">Cancellation</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Concurrent::Cancellation
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Synchronization/Object.html" title="Concurrent::Synchronization::Object (class)">Synchronization::Object</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Synchronization/Object.html" title="Concurrent::Synchronization::Object (class)">Synchronization::Object</a></span></li>
<li class="next">Concurrent::Cancellation</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/concurrent-ruby-edge/concurrent/edge/cancellation.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p><strong>Edge Features</strong> are under active development and may change frequently.</p>
<ul>
<li> Deprecations are not added before incompatible changes.</li>
<li> Edge version: <em>major</em> is always 0, <em>minor</em> bump means incompatible change,
<em>patch</em> bump means compatible change.</li>
<li> Edge features may also lack tests and documentation.</li>
<li> Features developed in <code>concurrent-ruby-edge</code> are expected to move
to <code>concurrent-ruby</code> when finalised.</li>
</ul>
</div>
</div>
<p>The Cancellation abstraction provides cooperative cancellation.</p>
<p>The standard methods <code>Thread#raise</code> of <code>Thread#kill</code> available in Ruby
are very dangerous (see linked the blog posts bellow).
Therefore concurrent-ruby provides an alternative.</p>
<ul>
<li><a href="https://jvns.ca/blog/2015/11/27/why-rubys-timeout-is-dangerous-and-thread-dot-raise-is-terrifying/">https://jvns.ca/blog/2015/11/27/why-rubys-timeout-is-dangerous-and-thread-dot-raise-is-terrifying/</a></li>
<li><a href="http://www.mikeperham.com/2015/05/08/timeout-rubys-most-dangerous-api/">http://www.mikeperham.com/2015/05/08/timeout-rubys-most-dangerous-api/</a></li>
<li><a href="http://blog.headius.com/2008/02/rubys-threadraise-threadkill-timeoutrb.html">http://blog.headius.com/2008/02/rubys-threadraise-threadkill-timeoutrb.html</a></li>
</ul>
<p>It provides an object which represents a task which can be executed,
the task has to get the reference to the object and periodically cooperatively check that it is not cancelled.
Good practices to make tasks cancellable:</p>
<ul>
<li>check cancellation every cycle of a loop which does significant work,</li>
<li>do all blocking actions in a loop with a timeout then on timeout check cancellation
and if ok block again with the timeout</li>
</ul>
<p>The idea was inspired by <a href="https://msdn.microsoft.com/en-us/library/dd537607(v=vs.110).aspx">https://msdn.microsoft.com/en-us/library/dd537607(v=vs.110).aspx</a>
<h2>Examples</h2>
<p><strong>Run async task until cancelled</strong></p>
<p>Create cancellation and then run work in a background thread until it is cancelled. </p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_cancellation'>cancellation</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'>Cancellation</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='comment'># => #<Concurrent::Cancellation:0x000002 pending>
</span><span class='comment'># - origin is used for cancelling, resolve it to cancel
</span><span class='comment'># - cancellation is passed down to tasks for cooperative cancellation
</span><span class='id identifier rubyid_async_task'>async_task</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Promises.html" title="Concurrent::Promises (module)">Promises</a></span></span><span class='period'>.</span><span class='id identifier rubyid_future'><span class='object_link'><a href="Promises/FactoryMethods.html#future-instance_method" title="Concurrent::Promises::FactoryMethods#future (method)">future</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_cancellation'>cancellation</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cancellation'>cancellation</span><span class='op'>|</span>
<span class='comment'># Do work repeatedly until it is cancelled
</span> <span class='id identifier rubyid_do_stuff'>do_stuff</span> <span class='kw'>until</span> <span class='id identifier rubyid_cancellation'>cancellation</span><span class='period'>.</span><span class='id identifier rubyid_canceled?'>canceled?</span>
<span class='symbol'>:stopped_gracefully</span>
<span class='kw'>end</span>
<span class='comment'># => #<Concurrent::Promises::Future:0x000003 pending>
</span>
<span class='id identifier rubyid_sleep'>sleep</span> <span class='float'>0.01</span> <span class='comment'># => 0
</span><span class='comment'># Wait a bit then stop the thread by resolving the origin of the cancellation
</span><span class='id identifier rubyid_origin'>origin</span><span class='period'>.</span><span class='id identifier rubyid_resolve'>resolve</span>
<span class='comment'># => #<Concurrent::Promises::ResolvableEvent:0x000004 resolved>
</span><span class='id identifier rubyid_async_task'>async_task</span><span class='period'>.</span><span class='id identifier rubyid_value!'>value!</span> <span class='comment'># => :stopped_gracefully
</span></code></pre>
<p>Or let it raise an error.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_cancellation'>cancellation</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'>Cancellation</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='comment'># => #<Concurrent::Cancellation:0x000005 pending>
</span><span class='id identifier rubyid_async_task'>async_task</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Promises.html" title="Concurrent::Promises (module)">Promises</a></span></span><span class='period'>.</span><span class='id identifier rubyid_future'><span class='object_link'><a href="Promises/FactoryMethods.html#future-instance_method" title="Concurrent::Promises::FactoryMethods#future (method)">future</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_cancellation'>cancellation</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cancellation'>cancellation</span><span class='op'>|</span>
<span class='comment'># Do work repeatedly until it is cancelled
</span> <span class='kw'>while</span> <span class='kw'>true</span>
<span class='id identifier rubyid_cancellation'>cancellation</span><span class='period'>.</span><span class='id identifier rubyid_check!'>check!</span>
<span class='id identifier rubyid_do_stuff'>do_stuff</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='comment'># => #<Concurrent::Promises::Future:0x000006 pending>
</span>
<span class='id identifier rubyid_sleep'>sleep</span> <span class='float'>0.01</span> <span class='comment'># => 0
</span><span class='comment'># Wait a bit then stop the thread by resolving the origin of the cancellation
</span><span class='id identifier rubyid_origin'>origin</span><span class='period'>.</span><span class='id identifier rubyid_resolve'>resolve</span>
<span class='comment'># => #<Concurrent::Promises::ResolvableEvent:0x000007 resolved>
</span><span class='id identifier rubyid_async_task'>async_task</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
<span class='comment'># => [false,
</span><span class='comment'># nil,
</span><span class='comment'># #<Concurrent::CancelledOperationError: Concurrent::CancelledOperationError>]
</span></code></pre>
<p><strong>Run additional tasks on Cancellation</strong> </p>
<p>Cancellation can also be used to log or plan re-execution.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_cancellation'>cancellation</span><span class='period'>.</span><span class='id identifier rubyid_origin'>origin</span><span class='period'>.</span><span class='id identifier rubyid_chain'>chain</span> <span class='kw'>do</span>
<span class='comment'># This block is executed after the Cancellation is cancelled
</span> <span class='comment'># It can then log cancellation or e.g. plan new re-execution
</span><span class='kw'>end</span>
<span class='comment'># => #<Concurrent::Promises::Future:0x000008 pending>
</span></code></pre>
<p><strong>Run only for limited time – Timeout replacement</strong></p>
<p>Execute task for a given time then finish.
Instead of letting Cancellation crate its own origin, it can be passed in as argument.
The passed in origin is scheduled to be resolved in given time which then cancels the Cancellation.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_timeout'>timeout</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'>Cancellation</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Promises.html" title="Concurrent::Promises (module)">Promises</a></span></span><span class='period'>.</span><span class='id identifier rubyid_schedule'><span class='object_link'><a href="Promises/FactoryMethods.html#schedule-instance_method" title="Concurrent::Promises::FactoryMethods#schedule (method)">schedule</a></span></span><span class='lparen'>(</span><span class='float'>0.02</span><span class='rparen'>)</span>
<span class='comment'># => #<Concurrent::Cancellation:0x000009 pending>
</span><span class='comment'># or using shortcut helper method
</span><span class='id identifier rubyid_timeout'>timeout</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'>Cancellation</span><span class='period'>.</span><span class='id identifier rubyid_timeout'><span class='object_link'><a href="#timeout-class_method" title="Concurrent::Cancellation.timeout (method)">timeout</a></span></span> <span class='float'>0.02</span>
<span class='comment'># => #<Concurrent::Cancellation:0x00000a pending>
</span><span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="AtomicFixnum.html" title="Concurrent::AtomicFixnum (class)">AtomicFixnum</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="AtomicFixnum.html#initialize-instance_method" title="Concurrent::AtomicFixnum#initialize (method)">new</a></span></span>
<span class='comment'># => #<Concurrent::AtomicFixnum:0x00000b value:0>
</span><span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='period'>.</span><span class='id identifier rubyid_global_io_executor'><span class='object_link'><a href="../Concurrent.html#global_io_executor-class_method" title="Concurrent.global_io_executor (method)">global_io_executor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_post'><span class='object_link'><a href="ThreadPoolExecutor.html#post-instance_method" title="Concurrent::ThreadPoolExecutor#post (method)">post</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_timeout'>timeout</span><span class='op'>|</span>
<span class='comment'># do stuff until cancelled
</span> <span class='id identifier rubyid_count'>count</span><span class='period'>.</span><span class='id identifier rubyid_increment'>increment</span> <span class='kw'>until</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='period'>.</span><span class='id identifier rubyid_canceled?'>canceled?</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_timeout'>timeout</span><span class='period'>.</span><span class='id identifier rubyid_origin'>origin</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='comment'># => #<Concurrent::Promises::Event:0x00000c resolved>
</span><span class='id identifier rubyid_count'>count</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> <span class='comment'># => 177576
</span></code></pre>
<p><strong>Parallel background processing with single cancellation</strong></p>
<p>Each task tries to count to 1000 but there is a randomly failing test. The
tasks share single cancellation, when one of them fails it cancels the others.
The failing tasks ends with an error, the other tasks are gracefully cancelled.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_cancellation'>cancellation</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'>Cancellation</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='comment'># => #<Concurrent::Cancellation:0x00000d pending>
</span><span class='id identifier rubyid_tasks'>tasks</span> <span class='op'>=</span> <span class='int'>4</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
<span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Promises.html" title="Concurrent::Promises (module)">Promises</a></span></span><span class='period'>.</span><span class='id identifier rubyid_future'><span class='object_link'><a href="Promises/FactoryMethods.html#future-instance_method" title="Concurrent::Promises::FactoryMethods#future (method)">future</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_cancellation'>cancellation</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span><span class='comma'>,</span> <span class='id identifier rubyid_i'>i</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cancellation'>cancellation</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span><span class='comma'>,</span> <span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
<span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='int'>100</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='kw'>do</span>
<span class='kw'>break</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='symbol'>:cancelled</span> <span class='kw'>if</span> <span class='id identifier rubyid_cancellation'>cancellation</span><span class='period'>.</span><span class='id identifier rubyid_canceled?'>canceled?</span>
<span class='id identifier rubyid_count'>count</span> <span class='op'>+=</span> <span class='int'>1</span>
<span class='id identifier rubyid_sleep'>sleep</span> <span class='float'>0.001</span>
<span class='kw'>if</span> <span class='id identifier rubyid_rand'>rand</span> <span class='op'>></span> <span class='float'>0.95</span>
<span class='id identifier rubyid_origin'>origin</span><span class='period'>.</span><span class='id identifier rubyid_resolve'>resolve</span> <span class='comment'># cancel
</span> <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>random error</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_count'>count</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='comment'># => [#<Concurrent::Promises::Future:0x00000e pending>,
</span><span class='comment'># #<Concurrent::Promises::Future:0x00000f pending>,
</span><span class='comment'># #<Concurrent::Promises::Future:0x000010 pending>,
</span><span class='comment'># #<Concurrent::Promises::Future:0x000011 pending>]
</span><span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Promises.html" title="Concurrent::Promises (module)">Promises</a></span></span><span class='period'>.</span><span class='id identifier rubyid_zip'>zip</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_tasks'>tasks</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_result'><span class='object_link'><a href="Promises/Future.html#result-instance_method" title="Concurrent::Promises::Future#result (method)">result</a></span></span>
<span class='comment'># => [false,
</span><span class='comment'># [:cancelled, nil, :cancelled, :cancelled],
</span><span class='comment'># [nil, #<RuntimeError: random error>, nil, nil]]
</span></code></pre>
<p>Without the randomly failing part it produces following.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_cancellation'>cancellation</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'>Cancellation</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='comment'># => #<Concurrent::Cancellation:0x000012 pending>
</span><span class='id identifier rubyid_tasks'>tasks</span> <span class='op'>=</span> <span class='int'>4</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
<span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Promises.html" title="Concurrent::Promises (module)">Promises</a></span></span><span class='period'>.</span><span class='id identifier rubyid_future'><span class='object_link'><a href="Promises/FactoryMethods.html#future-instance_method" title="Concurrent::Promises::FactoryMethods#future (method)">future</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_cancellation'>cancellation</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span><span class='comma'>,</span> <span class='id identifier rubyid_i'>i</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cancellation'>cancellation</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span><span class='comma'>,</span> <span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
<span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='int'>100</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='kw'>do</span>
<span class='kw'>break</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='symbol'>:cancelled</span> <span class='kw'>if</span> <span class='id identifier rubyid_cancellation'>cancellation</span><span class='period'>.</span><span class='id identifier rubyid_canceled?'>canceled?</span>
<span class='id identifier rubyid_count'>count</span> <span class='op'>+=</span> <span class='int'>1</span>
<span class='id identifier rubyid_sleep'>sleep</span> <span class='float'>0.001</span>
<span class='comment'># if rand > 0.95
</span> <span class='comment'># origin.resolve
</span> <span class='comment'># raise 'random error'
</span> <span class='comment'># end
</span> <span class='id identifier rubyid_count'>count</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='comment'># => [#<Concurrent::Promises::Future:0x000013 pending>,
</span><span class='comment'># #<Concurrent::Promises::Future:0x000014 pending>,
</span><span class='comment'># #<Concurrent::Promises::Future:0x000015 pending>,
</span><span class='comment'># #<Concurrent::Promises::Future:0x000016 pending>]
</span><span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Promises.html" title="Concurrent::Promises (module)">Promises</a></span></span><span class='period'>.</span><span class='id identifier rubyid_zip'>zip</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_tasks'>tasks</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_result'><span class='object_link'><a href="Promises/Future.html#result-instance_method" title="Concurrent::Promises::Future#result (method)">result</a></span></span>
<span class='comment'># => [true, [100, 100, 100, 100], nil]
</span></code></pre>
<p><strong>Combine cancellations</strong></p>
<p>The combination created by joining two cancellations cancels when the first or the other does.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_cancellation_a'>cancellation_a</span><span class='comma'>,</span> <span class='id identifier rubyid_origin_a'>origin_a</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'>Cancellation</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='comment'># => #<Concurrent::Cancellation:0x000017 pending>
</span><span class='id identifier rubyid_cancellation_b'>cancellation_b</span><span class='comma'>,</span> <span class='id identifier rubyid_origin_b'>origin_b</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'>Cancellation</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='comment'># => #<Concurrent::Cancellation:0x000018 pending>
</span><span class='id identifier rubyid_combined_cancellation'>combined_cancellation</span> <span class='op'>=</span> <span class='id identifier rubyid_cancellation_a'>cancellation_a</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_cancellation_b'>cancellation_b</span><span class='rparen'>)</span>
<span class='comment'># => #<Concurrent::Cancellation:0x000019 pending>
</span>
<span class='id identifier rubyid_origin_a'>origin_a</span><span class='period'>.</span><span class='id identifier rubyid_resolve'>resolve</span>
<span class='comment'># => #<Concurrent::Promises::ResolvableEvent:0x00001a resolved>
</span>
<span class='id identifier rubyid_cancellation_a'>cancellation_a</span><span class='period'>.</span><span class='id identifier rubyid_canceled?'>canceled?</span> <span class='comment'># => true
</span><span class='id identifier rubyid_cancellation_b'>cancellation_b</span><span class='period'>.</span><span class='id identifier rubyid_canceled?'>canceled?</span> <span class='comment'># => false
</span><span class='id identifier rubyid_combined_cancellation'>combined_cancellation</span><span class='period'>.</span><span class='id identifier rubyid_canceled?'>canceled?</span> <span class='comment'># => true
</span></code></pre>
<p>If a different rule for joining is needed, the source can be combined manually.
The manually created cancellation cancels when both the first and the other cancels.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_cancellation_a'>cancellation_a</span><span class='comma'>,</span> <span class='id identifier rubyid_origin_a'>origin_a</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'>Cancellation</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='comment'># => #<Concurrent::Cancellation:0x00001b pending>
</span><span class='id identifier rubyid_cancellation_b'>cancellation_b</span><span class='comma'>,</span> <span class='id identifier rubyid_origin_b'>origin_b</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'>Cancellation</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='comment'># => #<Concurrent::Cancellation:0x00001c pending>
</span><span class='comment'># cancels only when both a and b is cancelled
</span><span class='id identifier rubyid_combined_cancellation'>combined_cancellation</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'>Cancellation</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_origin_a'>origin_a</span> <span class='op'>&</span> <span class='id identifier rubyid_origin_b'>origin_b</span>
<span class='comment'># => #<Concurrent::Cancellation:0x00001d pending>
</span>
<span class='id identifier rubyid_origin_a'>origin_a</span><span class='period'>.</span><span class='id identifier rubyid_resolve'>resolve</span>
<span class='comment'># => #<Concurrent::Promises::ResolvableEvent:0x00001e resolved>
</span>
<span class='id identifier rubyid_cancellation_a'>cancellation_a</span><span class='period'>.</span><span class='id identifier rubyid_canceled?'>canceled?</span> <span class='comment'>#=> true
</span><span class='id identifier rubyid_cancellation_b'>cancellation_b</span><span class='period'>.</span><span class='id identifier rubyid_canceled?'>canceled?</span> <span class='comment'>#=> false
</span><span class='id identifier rubyid_combined_cancellation'>combined_cancellation</span><span class='period'>.</span><span class='id identifier rubyid_canceled?'>canceled?</span> <span class='comment'>#=> false
</span>
<span class='id identifier rubyid_origin_b'>origin_b</span><span class='period'>.</span><span class='id identifier rubyid_resolve'>resolve</span>
<span class='comment'># => #<Concurrent::Promises::ResolvableEvent:0x00001f resolved>
</span><span class='id identifier rubyid_combined_cancellation'>combined_cancellation</span><span class='period'>.</span><span class='id identifier rubyid_canceled?'>canceled?</span> <span class='comment'>#=> true
</span></code></pre>
</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#timeout-class_method" title="timeout (class method)">.<strong>timeout</strong>(intended_time) ⇒ Cancellation </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create Cancellation which will cancel itself in given time.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#canceled%3F-instance_method" title="#canceled? (instance method)">#<strong>canceled?</strong> ⇒ true, false </a>
</span>
<span class="summary_desc"><div class='inline'><p>Is the cancellation cancelled? Respective, was the origin of the cancellation resolved.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#check!-instance_method" title="#check! (instance method)">#<strong>check!</strong>(error = CancelledOperationError) ⇒ self </a>
</span>
<span class="summary_desc"><div class='inline'><p>Raise error when cancelled.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(origin = Promises.resolvable_event) ⇒ Cancellation </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Creates the cancellation object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#join-instance_method" title="#join (instance method)">#<strong>join</strong>(*cancellations) ⇒ Cancellation </a>
</span>
<span class="summary_desc"><div class='inline'><p>Creates a new Cancellation which is cancelled when first of the supplied cancellations or self is cancelled.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#origin-instance_method" title="#origin (instance method)">#<strong>origin</strong> ⇒ Promises::Future, Promises::Event </a>
</span>
<span class="summary_desc"><div class='inline'><p>The event or future which is the origin of the cancellation.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_ary-instance_method" title="#to_ary (instance method)">#<strong>to_ary</strong> ⇒ Array(Cancellation, Promises::Future), Array(Cancellation, Promises::Event) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Allow to multi-assign the Cancellation object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ String </a>
(also: #inspect)
</span>
<span class="summary_desc"><div class='inline'><p>Short string representation.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(origin = Promises.resolvable_event) ⇒ <tt><span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates the cancellation object.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code"><code><span class='id identifier rubyid_cancellation'>cancellation</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>origin</span>
<span class='type'>(<tt><span class='object_link'><a href="Promises/Future.html" title="Concurrent::Promises::Future (class)">Promises::Future</a></span></tt>, <tt><span class='object_link'><a href="Promises/Event.html" title="Concurrent::Promises::Event (class)">Promises::Event</a></span></tt>)</span>
<em class="default">(defaults to: <tt>Promises.resolvable_event</tt>)</em>
—
<div class='inline'><p>of the cancellation.
When it is resolved the cancellation is canceled.</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#to_ary-instance_method" title="Concurrent::Cancellation#to_ary (method)">#to_ary</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
52
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/edge/cancellation.rb', line 52</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_origin'>origin</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Promises.html" title="Concurrent::Promises (module)">Promises</a></span></span><span class='period'>.</span><span class='id identifier rubyid_resolvable_event'><span class='object_link'><a href="Promises/FactoryMethods.html#resolvable_event-instance_method" title="Concurrent::Promises::FactoryMethods#resolvable_event (method)">resolvable_event</a></span></span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span>
<span class='ivar'>@Origin</span> <span class='op'>=</span> <span class='id identifier rubyid_origin'>origin</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="timeout-class_method">
.<strong>timeout</strong>(intended_time) ⇒ <tt><span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create Cancellation which will cancel itself in given time</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>intended_time</span>
<span class='type'>(<tt>Numeric</tt>, <tt>Time</tt>)</span>
—
<div class='inline'><p><code>Numeric</code> means to run in <code>intended_time</code> seconds.
<code>Time</code> means to run on <code>intended_time</code>.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/edge/cancellation.rb', line 41</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_timeout'>timeout</span><span class='lparen'>(</span><span class='id identifier rubyid_intended_time'>intended_time</span><span class='rparen'>)</span>
<span class='id identifier rubyid_new'>new</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Promises.html" title="Concurrent::Promises (module)">Promises</a></span></span><span class='period'>.</span><span class='id identifier rubyid_schedule'><span class='object_link'><a href="Promises/FactoryMethods.html#schedule-instance_method" title="Concurrent::Promises::FactoryMethods#schedule (method)">schedule</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_intended_time'>intended_time</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="canceled?-instance_method">
#<strong>canceled?</strong> ⇒ <tt>true</tt>, <tt>false</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Is the cancellation cancelled?
Respective, was the origin of the cancellation resolved.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
75
76
77</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/edge/cancellation.rb', line 75</span>
<span class='kw'>def</span> <span class='id identifier rubyid_canceled?'>canceled?</span>
<span class='ivar'>@Origin</span><span class='period'>.</span><span class='id identifier rubyid_resolved?'>resolved?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="check!-instance_method">
#<strong>check!</strong>(error = CancelledOperationError) ⇒ <tt>self</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Raise error when cancelled</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>error</span>
<span class='type'>(<tt>#exception</tt>)</span>
<em class="default">(defaults to: <tt>CancelledOperationError</tt>)</em>
—
<div class='inline'><p>to be risen</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>self</tt>)</span>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'></span>
<div class='inline'><p>the error</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
83
84
85
86</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/edge/cancellation.rb', line 83</span>
<span class='kw'>def</span> <span class='id identifier rubyid_check!'>check!</span><span class='lparen'>(</span><span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html#CancelledOperationError-constant" title="Concurrent::CancelledOperationError (constant)">CancelledOperationError</a></span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_error'>error</span> <span class='kw'>if</span> <span class='id identifier rubyid_canceled?'>canceled?</span>
<span class='kw'>self</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="join-instance_method">
#<strong>join</strong>(*cancellations) ⇒ <tt><span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates a new Cancellation which is cancelled when first
of the supplied cancellations or self is cancelled.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>cancellations</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span></tt>)</span>
—
<div class='inline'><p>to combine</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span></tt>)</span>
—
<div class='inline'><p>new cancellation</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
93
94
95</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/edge/cancellation.rb', line 93</span>
<span class='kw'>def</span> <span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_cancellations'>cancellations</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='const'><span class='object_link'><a href="Promises.html" title="Concurrent::Promises (module)">Promises</a></span></span><span class='period'>.</span><span class='id identifier rubyid_any_event'><span class='object_link'><a href="Promises/FactoryMethods.html#any_event-instance_method" title="Concurrent::Promises::FactoryMethods#any_event (method)">any_event</a></span></span><span class='lparen'>(</span><span class='op'>*</span><span class='lbracket'>[</span><span class='ivar'>@Origin</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_cancellations'>cancellations</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:origin</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="origin-instance_method">
#<strong>origin</strong> ⇒ <tt><span class='object_link'><a href="Promises/Future.html" title="Concurrent::Promises::Future (class)">Promises::Future</a></span></tt>, <tt><span class='object_link'><a href="Promises/Event.html" title="Concurrent::Promises::Event (class)">Promises::Event</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>The event or future which is the origin of the cancellation</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Promises/Future.html" title="Concurrent::Promises::Future (class)">Promises::Future</a></span></tt>, <tt><span class='object_link'><a href="Promises/Event.html" title="Concurrent::Promises::Event (class)">Promises::Event</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/edge/cancellation.rb', line 68</span>
<span class='kw'>def</span> <span class='id identifier rubyid_origin'>origin</span>
<span class='ivar'>@Origin</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_ary-instance_method">
#<strong>to_ary</strong> ⇒ <tt><span class='object_link'><a href="Array.html" title="Concurrent::Array (class)">Array</a></span>(<span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span>, <span class='object_link'><a href="Promises/Future.html" title="Concurrent::Promises::Future (class)">Promises::Future</a></span>)</tt>, <tt><span class='object_link'><a href="Array.html" title="Concurrent::Array (class)">Array</a></span>(<span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span>, <span class='object_link'><a href="Promises/Event.html" title="Concurrent::Promises::Event (class)">Promises::Event</a></span>)</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Allow to multi-assign the Cancellation object</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code"><code><span class='id identifier rubyid_cancellation'>cancellation</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='id identifier rubyid_cancellation'>cancellation</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span></code></pre>
</div>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Array.html" title="Concurrent::Array (class)">Array</a></span>(<span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span>, <span class='object_link'><a href="Promises/Future.html" title="Concurrent::Promises::Future (class)">Promises::Future</a></span>)</tt>, <tt><span class='object_link'><a href="Array.html" title="Concurrent::Array (class)">Array</a></span>(<span class='object_link'><a href="" title="Concurrent::Cancellation (class)">Cancellation</a></span>, <span class='object_link'><a href="Promises/Event.html" title="Concurrent::Promises::Event (class)">Promises::Event</a></span>)</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/edge/cancellation.rb', line 62</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_ary'>to_ary</span>
<span class='lbracket'>[</span><span class='kw'>self</span><span class='comma'>,</span> <span class='ivar'>@Origin</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_s-instance_method">
#<strong>to_s</strong> ⇒ <tt>String</tt>
<span class="aliases">Also known as:
<span class="names"><span id='inspect-instance_method'>inspect</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Short string representation.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/edge/cancellation.rb', line 99</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
<span class='id identifier rubyid_format'>format</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>%s %s></span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>super</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='op'>-</span><span class='int'>2</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_canceled?'>canceled?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>canceled</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>pending</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_blank">yard</a>.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-57940973-1', 'auto');
ga('send', 'pageview');
</script>
</div>
</body>
</html>
|