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
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Concurrent::Channel::Buffer::Unbuffered
— 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::Channel::Buffer::Unbuffered";
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 (U)</a> »
<span class='title'><span class='object_link'><a href="../../../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span> » <span class='title'><span class='object_link'><a href="../../Channel.html" title="Concurrent::Channel (class)">Channel</a></span></span> » <span class='title'><span class='object_link'><a href="../Buffer.html" title="Concurrent::Channel::Buffer (module)">Buffer</a></span></span>
»
<span class="title">Unbuffered</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::Channel::Buffer::Unbuffered
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Base.html" title="Concurrent::Channel::Buffer::Base (class)">Base</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'>Synchronization::LockableObject</span></li>
<li class="next"><span class='object_link'><a href="Base.html" title="Concurrent::Channel::Buffer::Base (class)">Base</a></span></li>
<li class="next">Concurrent::Channel::Buffer::Unbuffered</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/concurrent-ruby-edge/concurrent/channel/buffer/unbuffered.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A blocking buffer with a size of zero. An item can only be put onto
the buffer when a thread is waiting to take. Similarly, an item can
only be put onto the buffer when a thread is waiting to put. When
either <span class='object_link'><a href="#put-instance_method" title="Concurrent::Channel::Buffer::Unbuffered#put (method)">#put</a></span> or <span class='object_link'><a href="#take-instance_method" title="Concurrent::Channel::Buffer::Unbuffered#take (method)">#take</a></span> is called and there is no corresponding call
in progress, the call will block indefinitely. Any other calls to the
same method will queue behind the first call and block as well. As
soon as a corresponding put/take call is made an exchange will occur
and the first blocked call will return.</p>
</div>
</div>
<div class="tags">
</div>
<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="#empty%3F-instance_method" title="#empty? (instance method)">#<strong>empty?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Predicate indicating if the buffer is empty.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#full%3F-instance_method" title="#full? (instance method)">#<strong>full?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Predicate indicating if the buffer is full.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#next-instance_method" title="#next (instance method)">#<strong>next</strong> ⇒ Object, Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Take the next "item" from the buffer and also return a boolean indicating if "more" items can be taken.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#offer-instance_method" title="#offer (instance method)">#<strong>offer</strong>(item) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Put an item onto the buffer if possible.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#poll-instance_method" title="#poll (instance method)">#<strong>poll</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Take the next item from the buffer if one is available else return immediately.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#put-instance_method" title="#put (instance method)">#<strong>put</strong>(item) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Put an item onto the buffer if possible.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#size-instance_method" title="#size (instance method)">#<strong>size</strong> ⇒ undocumented </a>
</span>
<span class="summary_desc"><div class='inline'><p>The number of items currently in the buffer.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#take-instance_method" title="#take (instance method)">#<strong>take</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Take an item from the buffer if one is available.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="Concurrent::Channel::Buffer::Base#initialize (method)">Concurrent::Channel::Buffer::Base</a></span></p>
</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="empty?-instance_method">
#<strong>empty?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Predicate indicating if the buffer is empty.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if this buffer is empty else false</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/channel/buffer/unbuffered.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_size'>size</span> <span class='op'>==</span> <span class='int'>0</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="full?-instance_method">
#<strong>full?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Predicate indicating if the buffer is full.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if this buffer is full else false</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/channel/buffer/unbuffered.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_full?'>full?</span>
<span class='op'>!</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="next-instance_method">
#<strong>next</strong> ⇒ <tt>Object</tt>, <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Take the next "item" from the buffer and also return a boolean
indicating if "more" items can be taken. Used for iterating
over a buffer until it is closed and empty.</p>
<p>If the buffer is open but no items remain the calling thread will
block until an item is available. The second of the two return
values, "more" (a boolean), will always be <code>true</code> when the buffer is
open. The "more" value will be <code>false</code> when the channel has been
closed and all values have already been received. When "more" is
false the returned item will be <code>Concurrent::NULL</code>.</p>
<p>Note that when multiple threads access the same channel a race
condition can occur when using this method. A call to <code>next</code> from
one thread may return <code>true</code> for the second return value, but
another thread may <code>take</code> the last value before the original
thread makes another call. Code which iterates over a channel
must be programmed to properly handle these race conditions.</p>
<p>Items can only be taken from the buffer when one or more threads are
waiting to <span class='object_link'><a href="#put-instance_method" title="Concurrent::Channel::Buffer::Unbuffered#put (method)">#put</a></span> items onto the buffer. This method exhibits the
same blocking behavior as <span class='object_link'><a href="#take-instance_method" title="Concurrent::Channel::Buffer::Unbuffered#take (method)">#take</a></span>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>, <tt>Boolean</tt>)</span>
—
<div class='inline'><p>the first return value will be the item
taken from the buffer and the second return value will be a
boolean indicating whether or not more items remain.</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#take-instance_method" title="Concurrent::Channel::Buffer::Unbuffered#take (method)">#take</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
135
136
137
138
139</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/channel/buffer/unbuffered.rb', line 135</span>
<span class='kw'>def</span> <span class='kw'>next</span>
<span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='id identifier rubyid_take'>take</span>
<span class='id identifier rubyid_more'>more</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_item'>item</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'>NULL</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid_more'>more</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="offer-instance_method">
#<strong>offer</strong>(item) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Put an item onto the buffer if possible. If the buffer is open but
unable to add an item, probably due to being full, the method will
return immediately. Similarly, the method will return immediately
when the buffer is closed. A return value of <code>false</code> does not
necessarily indicate that the buffer is closed, just that the item
could not be added.</p>
<p>Items can only be put onto the buffer when one or more threads are
waiting to <span class='object_link'><a href="#take-instance_method" title="Concurrent::Channel::Buffer::Unbuffered#take (method)">#take</a></span> items off the buffer. When there is a thread
waiting to take an item this method will give its item and return
<code>true</code> immediately. When there are no threads waiting to take or the
buffer is closed, this method will return <code>false</code> immediately.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>item</span>
<span class='type'>(<tt>Object</tt>)</span>
—
<div class='inline'><p>the item/value to put onto the buffer.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if the item was added to the buffer else
false (always false when closed).</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
71
72
73
74
75
76
77
78
79</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/channel/buffer/unbuffered.rb', line 71</span>
<span class='kw'>def</span> <span class='id identifier rubyid_offer'>offer</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span>
<span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_ns_closed?'>ns_closed?</span> <span class='op'>||</span> <span class='id identifier rubyid_taking'>taking</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_taken'>taken</span> <span class='op'>=</span> <span class='id identifier rubyid_taking'>taking</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
<span class='id identifier rubyid_taken'>taken</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span>
<span class='kw'>true</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="poll-instance_method">
#<strong>poll</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Take the next item from the buffer if one is available else return
immediately. Failing to return a value does not necessarily
indicate that the buffer is closed, just that it is empty.</p>
<p>Items can only be taken off the buffer when one or more threads are
waiting to <span class='object_link'><a href="#put-instance_method" title="Concurrent::Channel::Buffer::Unbuffered#put (method)">#put</a></span> items onto the buffer. When there is a thread
waiting to put an item this method will take the item and return
it immediately. When there are no threads waiting to put or the
buffer is closed, this method will return <code>Concurrent::NULL</code> immediately.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
—
<div class='inline'><p>the next item from the buffer or <code>Concurrent::NULL</code> if
the buffer is empty.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
117
118
119
120
121
122
123
124
125
126</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/channel/buffer/unbuffered.rb', line 117</span>
<span class='kw'>def</span> <span class='id identifier rubyid_poll'>poll</span>
<span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
<span class='kw'>return</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'>NULL</span> <span class='kw'>if</span> <span class='id identifier rubyid_putting'>putting</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_put'>put</span> <span class='op'>=</span> <span class='id identifier rubyid_putting'>putting</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_put'>put</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
<span class='id identifier rubyid_put'>put</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="put-instance_method">
#<strong>put</strong>(item) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Put an item onto the buffer if possible. If the buffer is open
but not able to accept the item the calling thread will block
until the item can be put onto the buffer.</p>
<p>Items can only be put onto the buffer when one or more threads are
waiting to <span class='object_link'><a href="#take-instance_method" title="Concurrent::Channel::Buffer::Unbuffered#take (method)">#take</a></span> items off the buffer. When there is a thread
waiting to take an item this method will give its item and return
immediately. When there are no threads waiting to take, this method
will block. As soon as a thread calls <code>take</code> the exchange will
occur and this method will return.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>item</span>
<span class='type'>(<tt>Object</tt>)</span>
—
<div class='inline'><p>the item/value to put onto the buffer.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if the item was added to the buffer else
false (always false when closed).</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/channel/buffer/unbuffered.rb', line 44</span>
<span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span>
<span class='id identifier rubyid_mine'>mine</span> <span class='op'>=</span> <span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_ns_closed?'>ns_closed?</span>
<span class='id identifier rubyid_ref'>ref</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="../../AtomicReference.html" title="Concurrent::AtomicReference (class)">AtomicReference</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../AtomicReference.html#initialize-instance_method" title="Concurrent::AtomicReference#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_taking'>taking</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_putting'>putting</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_ref'>ref</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_taken'>taken</span> <span class='op'>=</span> <span class='id identifier rubyid_taking'>taking</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
<span class='id identifier rubyid_taken'>taken</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span>
<span class='id identifier rubyid_ref'>ref</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_ref'>ref</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_loop'>loop</span> <span class='kw'>do</span>
<span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_mine'>mine</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_pass'>pass</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="size-instance_method">
#<strong>size</strong> ⇒ <tt>undocumented</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The number of items currently in the buffer.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/channel/buffer/unbuffered.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
<span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
<span class='id identifier rubyid_putting'>putting</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>?</span> <span class='int'>0</span> <span class='op'>:</span> <span class='int'>1</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="take-instance_method">
#<strong>take</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Take an item from the buffer if one is available. If the buffer
is open and no item is available the calling thread will block
until an item is available. If the buffer is closed but items
are available the remaining items can still be taken. Once the
buffer closes, no remaining items can be taken.</p>
<p>Items can only be taken from the buffer when one or more threads are
waiting to <span class='object_link'><a href="#put-instance_method" title="Concurrent::Channel::Buffer::Unbuffered#put (method)">#put</a></span> items onto the buffer. When there is a thread
waiting to put an item this method will take that item and return it
immediately. When there are no threads waiting to put, this method
will block. As soon as a thread calls <code>pur</code> the exchange will occur
and this method will return.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
—
<div class='inline'><p>the item removed from the buffer; <code>Concurrent::NULL</code> once
the buffer has closed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/channel/buffer/unbuffered.rb', line 89</span>
<span class='kw'>def</span> <span class='id identifier rubyid_take'>take</span>
<span class='id identifier rubyid_mine'>mine</span> <span class='op'>=</span> <span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
<span class='kw'>return</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'>NULL</span> <span class='kw'>if</span> <span class='id identifier rubyid_ns_closed?'>ns_closed?</span> <span class='op'>&&</span> <span class='id identifier rubyid_putting'>putting</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_ref'>ref</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="../../AtomicReference.html" title="Concurrent::AtomicReference (class)">AtomicReference</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../AtomicReference.html#initialize-instance_method" title="Concurrent::AtomicReference#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>nil</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_putting'>putting</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_taking'>taking</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_ref'>ref</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_put'>put</span> <span class='op'>=</span> <span class='id identifier rubyid_putting'>putting</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
<span class='id identifier rubyid_ref'>ref</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_put'>put</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
<span class='id identifier rubyid_put'>put</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_ref'>ref</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_loop'>loop</span> <span class='kw'>do</span>
<span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='id identifier rubyid_mine'>mine</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
<span class='kw'>return</span> <span class='id identifier rubyid_item'>item</span> <span class='kw'>if</span> <span class='id identifier rubyid_item'>item</span>
<span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_pass'>pass</span>
<span class='kw'>end</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>
|