rubygems
/
concurrent-ruby
1
0
Fork 0
Code Packages Releases Activity
concurrent-ruby/docs/1.1.0/Concurrent/Promises/AbstractEventFuture.html

2096 lines
51 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Concurrent::Promises::AbstractEventFuture
&mdash; Concurrent Ruby
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "Concurrent::Promises::AbstractEventFuture";
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 (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Promises.html" title="Concurrent::Promises (module)">Promises</a></span></span>
&raquo;
<span class="title">AbstractEventFuture</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::Promises::AbstractEventFuture
</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::Promises::AbstractEventFuture</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="AbstractEventFuture/ThrottleIntegration.html" title="Concurrent::Promises::AbstractEventFuture::ThrottleIntegration (module)">ThrottleIntegration</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/concurrent/promises.rb<span class="defines">,<br />
lib-edge/concurrent/edge/throttle.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Common ancestor of <span class='object_link'><a href="Event.html" title="Concurrent::Promises::Event (class)">Event</a></span> and <span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span> classes, many shared methods are defined here.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Event.html" title="Concurrent::Promises::Event (class)">Event</a></span>, <span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></p>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="AbstractEventFuture/ThrottleIntegration.html" title="Concurrent::Promises::AbstractEventFuture::ThrottleIntegration (module)">ThrottleIntegration</a></span>
</p>
<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="#chain-instance_method" title="#chain (instance method)">#<strong>chain</strong>(*args, &amp;task) &#x21d2; Future </a>
</span>
<span class="summary_desc"><div class='inline'><p>Shortcut of <span class='object_link'><a href="#chain_on-instance_method" title="Concurrent::Promises::AbstractEventFuture#chain_on (method)">#chain_on</a></span> with default <code>:io</code> executor supplied.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#chain_on-instance_method" title="#chain_on (instance method)">#<strong>chain_on</strong>(executor, *args, &amp;task) &#x21d2; Future </a>
</span>
<span class="summary_desc"><div class='inline'><p>Chains the task to be executed asynchronously on executor after it is resolved.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#chain_resolvable-instance_method" title="#chain_resolvable (instance method)">#<strong>chain_resolvable</strong>(resolvable) &#x21d2; self </a>
(also: #tangle)
</span>
<span class="summary_desc"><div class='inline'><p>Resolves the resolvable when receiver is resolved.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#chain_throttled_by-instance_method" title="#chain_throttled_by (instance method)">#<strong>chain_throttled_by</strong>(throttle, *args, &amp;block) &#x21d2; Future, Event </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="AbstractEventFuture/ThrottleIntegration.html#chain_throttled_by-instance_method" title="Concurrent::Promises::AbstractEventFuture::ThrottleIntegration#chain_throttled_by (method)">ThrottleIntegration</a></span>
</span>
<span class="summary_desc"><div class='inline'><p>Behaves as <span class='object_link'><a href="#chain-instance_method" title="Concurrent::Promises::AbstractEventFuture#chain (method)">#chain</a></span> but the it is throttled.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#default_executor-instance_method" title="#default_executor (instance method)">#<strong>default_executor</strong> &#x21d2; Executor </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns default executor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_resolution-instance_method" title="#on_resolution (instance method)">#<strong>on_resolution</strong>(*args, &amp;callback) &#x21d2; self </a>
</span>
<span class="summary_desc"><div class='inline'><p>Shortcut of <span class='object_link'><a href="#on_resolution_using-instance_method" title="Concurrent::Promises::AbstractEventFuture#on_resolution_using (method)">#on_resolution_using</a></span> with default <code>:io</code> executor supplied.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_resolution!-instance_method" title="#on_resolution! (instance method)">#<strong>on_resolution!</strong>(*args, &amp;callback) &#x21d2; self </a>
</span>
<span class="summary_desc"><div class='inline'><p>Stores the callback to be executed synchronously on resolving thread after it is resolved.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_resolution_using-instance_method" title="#on_resolution_using (instance method)">#<strong>on_resolution_using</strong>(executor, *args, &amp;callback) &#x21d2; self </a>
</span>
<span class="summary_desc"><div class='inline'><p>Stores the callback to be executed asynchronously on executor after it is resolved.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#pending%3F-instance_method" title="#pending? (instance method)">#<strong>pending?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Is it in pending state?.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#resolved%3F-instance_method" title="#resolved? (instance method)">#<strong>resolved?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Is it in resolved state?.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#state-instance_method" title="#state (instance method)">#<strong>state</strong> &#x21d2; Symbol </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns its state.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#throttled_by-instance_method" title="#throttled_by (instance method)">#<strong>throttled_by</strong>(throttle) {|a| ... } &#x21d2; Future, Event </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="AbstractEventFuture/ThrottleIntegration.html#throttled_by-instance_method" title="Concurrent::Promises::AbstractEventFuture::ThrottleIntegration#throttled_by (method)">ThrottleIntegration</a></span>
</span>
<span class="summary_desc"><div class='inline'></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> &#x21d2; String </a>
(also: #inspect)
</span>
<span class="summary_desc"><div class='inline'><p>Short string representation.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#touch-instance_method" title="#touch (instance method)">#<strong>touch</strong> &#x21d2; self </a>
</span>
<span class="summary_desc"><div class='inline'><p>Propagates touch.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#wait-instance_method" title="#wait (instance method)">#<strong>wait</strong>(timeout = nil) &#x21d2; Future, true, false </a>
</span>
<span class="summary_desc"><div class='inline'><p>Wait (block the Thread) until receiver is <span class='object_link'><a href="#resolved%3F-instance_method" title="Concurrent::Promises::AbstractEventFuture#resolved? (method)">#resolved?</a></span>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#with_default_executor-instance_method" title="#with_default_executor (instance method)">#<strong>with_default_executor</strong>(executor) &#x21d2; AbstractEventFuture </a>
</span>
<span class="abstract note title">abstract</span>
<span class="summary_desc"><div class='inline'><p>Crates new object with same class with the executor set as its new default executor.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="chain-instance_method">
#<strong>chain</strong>(*args, &amp;task) &#x21d2; <tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Shortcut of <span class='object_link'><a href="#chain_on-instance_method" title="Concurrent::Promises::AbstractEventFuture#chain_on (method)">#chain_on</a></span> with default <code>:io</code> executor supplied.</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="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#chain_on-instance_method" title="Concurrent::Promises::AbstractEventFuture#chain_on (method)">#chain_on</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
576
577
578</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 576</span>
<span class='kw'>def</span> <span class='id identifier rubyid_chain'>chain</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_task'>task</span><span class='rparen'>)</span>
<span class='id identifier rubyid_chain_on'>chain_on</span> <span class='ivar'>@DefaultExecutor</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_task'>task</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="chain_on-instance_method">
<span class="overload">#<strong>an_event.chain_on</strong>(executor, *args) {|*args| ... } &#x21d2; <tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt> </span>
<span class="overload">#<strong>a_future.chain_on</strong>(executor, *args) {|fulfilled, value, reason, *args| ... } &#x21d2; <tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt> </span>
</h3><div class="docstring">
<div class="discussion">
<p>Chains the task to be executed asynchronously on executor after it is resolved.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Overloads:</p>
<ul class="overload">
<li class="overload_item">
<span class="signature">#<strong>an_event.chain_on</strong>(executor, *args) {|*args| ... } &#x21d2; <tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt> </span>
<div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'>(<tt>*args</tt>)</span>
&mdash;
<div class='inline'><p>to the task.</p>
</div>
</li>
</ul>
</div>
</li>
<li class="overload_item">
<span class="signature">#<strong>a_future.chain_on</strong>(executor, *args) {|fulfilled, value, reason, *args| ... } &#x21d2; <tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt> </span>
<div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'>(<tt>fulfilled</tt>, <tt>value</tt>, <tt>reason</tt>, <tt>*args</tt>)</span>
&mdash;
<div class='inline'><p>to the task.</p>
</div>
</li>
</ul>
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>fulfilled</span>
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
</li>
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>Exception</tt>)</span>
</li>
</ul>
</div>
</li>
</ul>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>executor</span>
<span class='type'>(<tt>Executor</tt>, <tt>:io</tt>, <tt>:fast</tt>)</span>
&mdash;
<div class='inline'><p>Instance of an executor or a name of the
global executor. The task is executed on it, default executor remains unchanged.</p>
</div>
</li>
<li>
<span class='name'>args</span>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'><p>arguments which are passed to the task when it&#39;s executed.
(It might be prepended with other arguments, see the @yeild section).</p>
</div>
</li>
</ul>
<p class="tag_title">Yield Returns:</p>
<ul class="yieldreturn">
<li>
<span class='type'></span>
<div class='inline'><p>will become result of the returned Future.
Its returned value becomes <span class='object_link'><a href="Future.html#value-instance_method" title="Concurrent::Promises::Future#value (method)">Future#value</a></span> fulfilling it,
raised exception becomes <span class='object_link'><a href="Future.html#reason-instance_method" title="Concurrent::Promises::Future#reason (method)">Future#reason</a></span> rejecting it.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
594
595
596</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 594</span>
<span class='kw'>def</span> <span class='id identifier rubyid_chain_on'>chain_on</span><span class='lparen'>(</span><span class='id identifier rubyid_executor'>executor</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_task'>task</span><span class='rparen'>)</span>
<span class='const'>ChainPromise</span><span class='period'>.</span><span class='id identifier rubyid_new_blocked_by1'>new_blocked_by1</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='ivar'>@DefaultExecutor</span><span class='comma'>,</span> <span class='id identifier rubyid_executor'>executor</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_task'>task</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_future'>future</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="chain_resolvable-instance_method">
#<strong>chain_resolvable</strong>(resolvable) &#x21d2; <tt>self</tt>
<span class="aliases">Also known as:
<span class="names"><span id='tangle-instance_method'>tangle</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Resolves the resolvable when receiver is resolved.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>resolvable</span>
<span class='type'>(<tt><span class='object_link'><a href="Resolvable.html" title="Concurrent::Promises::Resolvable (module)">Resolvable</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>self</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
609
610
611</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 609</span>
<span class='kw'>def</span> <span class='id identifier rubyid_chain_resolvable'>chain_resolvable</span><span class='lparen'>(</span><span class='id identifier rubyid_resolvable'>resolvable</span><span class='rparen'>)</span>
<span class='id identifier rubyid_on_resolution!'>on_resolution!</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_resolvable'>resolvable</span><span class='period'>.</span><span class='id identifier rubyid_resolve_with'>resolve_with</span> <span class='id identifier rubyid_internal_state'>internal_state</span> <span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="chain_throttled_by-instance_method">
#<strong>chain_throttled_by</strong>(throttle, *args, &amp;block) &#x21d2; <tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt>, <tt><span class='object_link'><a href="Event.html" title="Concurrent::Promises::Event (class)">Event</a></span></tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="AbstractEventFuture/ThrottleIntegration.html#chain_throttled_by-instance_method" title="Concurrent::Promises::AbstractEventFuture::ThrottleIntegration#chain_throttled_by (method)">ThrottleIntegration</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Behaves as <span class='object_link'><a href="#chain-instance_method" title="Concurrent::Promises::AbstractEventFuture#chain (method)">Concurrent::Promises::AbstractEventFuture#chain</a></span> but the it is throttled.</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="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt>, <tt><span class='object_link'><a href="Event.html" title="Concurrent::Promises::Event (class)">Event</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#chain-instance_method" title="Concurrent::Promises::AbstractEventFuture#chain (method)">Concurrent::Promises::AbstractEventFuture#chain</a></span></li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="default_executor-instance_method">
#<strong>default_executor</strong> &#x21d2; <tt>Executor</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns default executor.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Executor</tt>)</span>
&mdash;
<div class='inline'><p>default executor</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#with_default_executor-instance_method" title="Concurrent::Promises::AbstractEventFuture#with_default_executor (method)">#with_default_executor</a></span></li>
<li><span class='object_link'><a href="FactoryMethods.html#future_on-instance_method" title="Concurrent::Promises::FactoryMethods#future_on (method)">FactoryMethods#future_on</a></span></li>
<li><span class='object_link'><a href="FactoryMethods.html#resolvable_future-instance_method" title="Concurrent::Promises::FactoryMethods#resolvable_future (method)">FactoryMethods#resolvable_future</a></span></li>
<li><span class='object_link'><a href="FactoryMethods.html#any_fulfilled_future_on-instance_method" title="Concurrent::Promises::FactoryMethods#any_fulfilled_future_on (method)">FactoryMethods#any_fulfilled_future_on</a></span></li>
<li>similar</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
570
571
572</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 570</span>
<span class='kw'>def</span> <span class='id identifier rubyid_default_executor'>default_executor</span>
<span class='ivar'>@DefaultExecutor</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_resolution-instance_method">
#<strong>on_resolution</strong>(*args, &amp;callback) &#x21d2; <tt>self</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Shortcut of <span class='object_link'><a href="#on_resolution_using-instance_method" title="Concurrent::Promises::AbstractEventFuture#on_resolution_using (method)">#on_resolution_using</a></span> with default <code>:io</code> executor supplied.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>self</tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#on_resolution_using-instance_method" title="Concurrent::Promises::AbstractEventFuture#on_resolution_using (method)">#on_resolution_using</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
617
618
619</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 617</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_resolution'>on_resolution</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_callback'>callback</span><span class='rparen'>)</span>
<span class='id identifier rubyid_on_resolution_using'>on_resolution_using</span> <span class='ivar'>@DefaultExecutor</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_callback'>callback</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_resolution!-instance_method">
<span class="overload">#<strong>an_event.on_resolution!</strong>(*args) {|*args| ... } &#x21d2; <tt>self</tt> </span>
<span class="overload">#<strong>a_future.on_resolution!</strong>(*args) {|fulfilled, value, reason, *args| ... } &#x21d2; <tt>self</tt> </span>
</h3><div class="docstring">
<div class="discussion">
<p>Stores the callback to be executed synchronously on resolving thread after it is
resolved.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Overloads:</p>
<ul class="overload">
<li class="overload_item">
<span class="signature">#<strong>an_event.on_resolution!</strong>(*args) {|*args| ... } &#x21d2; <tt>self</tt> </span>
<div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'>(<tt>*args</tt>)</span>
&mdash;
<div class='inline'><p>to the callback.</p>
</div>
</li>
</ul>
</div>
</li>
<li class="overload_item">
<span class="signature">#<strong>a_future.on_resolution!</strong>(*args) {|fulfilled, value, reason, *args| ... } &#x21d2; <tt>self</tt> </span>
<div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'>(<tt>fulfilled</tt>, <tt>value</tt>, <tt>reason</tt>, <tt>*args</tt>)</span>
&mdash;
<div class='inline'><p>to the callback.</p>
</div>
</li>
</ul>
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>fulfilled</span>
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
</li>
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>Exception</tt>)</span>
</li>
</ul>
</div>
</li>
</ul>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>args</span>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'><p>arguments which are passed to the task when it&#39;s executed.
(It might be prepended with other arguments, see the @yeild section).</p>
</div>
</li>
</ul>
<p class="tag_title">Yield Returns:</p>
<ul class="yieldreturn">
<li>
<span class='type'></span>
<div class='inline'><p>is forgotten.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>self</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
635
636
637</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 635</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_resolution!'>on_resolution!</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_callback'>callback</span><span class='rparen'>)</span>
<span class='id identifier rubyid_add_callback'>add_callback</span> <span class='symbol'>:callback_on_resolution</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_resolution_using-instance_method">
<span class="overload">#<strong>an_event.on_resolution_using</strong>(executor, *args) {|*args| ... } &#x21d2; <tt>self</tt> </span>
<span class="overload">#<strong>a_future.on_resolution_using</strong>(executor, *args) {|fulfilled, value, reason, *args| ... } &#x21d2; <tt>self</tt> </span>
</h3><div class="docstring">
<div class="discussion">
<p>Stores the callback to be executed asynchronously on executor after it is resolved.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Overloads:</p>
<ul class="overload">
<li class="overload_item">
<span class="signature">#<strong>an_event.on_resolution_using</strong>(executor, *args) {|*args| ... } &#x21d2; <tt>self</tt> </span>
<div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'>(<tt>*args</tt>)</span>
&mdash;
<div class='inline'><p>to the callback.</p>
</div>
</li>
</ul>
</div>
</li>
<li class="overload_item">
<span class="signature">#<strong>a_future.on_resolution_using</strong>(executor, *args) {|fulfilled, value, reason, *args| ... } &#x21d2; <tt>self</tt> </span>
<div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'>(<tt>fulfilled</tt>, <tt>value</tt>, <tt>reason</tt>, <tt>*args</tt>)</span>
&mdash;
<div class='inline'><p>to the callback.</p>
</div>
</li>
</ul>
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>fulfilled</span>
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
</li>
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>Exception</tt>)</span>
</li>
</ul>
</div>
</li>
</ul>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>executor</span>
<span class='type'>(<tt>Executor</tt>, <tt>:io</tt>, <tt>:fast</tt>)</span>
&mdash;
<div class='inline'><p>Instance of an executor or a name of the
global executor. The task is executed on it, default executor remains unchanged.</p>
</div>
</li>
<li>
<span class='name'>args</span>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'><p>arguments which are passed to the task when it&#39;s executed.
(It might be prepended with other arguments, see the @yeild section).</p>
</div>
</li>
</ul>
<p class="tag_title">Yield Returns:</p>
<ul class="yieldreturn">
<li>
<span class='type'></span>
<div class='inline'><p>is forgotten.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>self</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
653
654
655</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 653</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_resolution_using'>on_resolution_using</span><span class='lparen'>(</span><span class='id identifier rubyid_executor'>executor</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_callback'>callback</span><span class='rparen'>)</span>
<span class='id identifier rubyid_add_callback'>add_callback</span> <span class='symbol'>:async_callback_on_resolution</span><span class='comma'>,</span> <span class='id identifier rubyid_executor'>executor</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="pending?-instance_method">
#<strong>pending?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Is it in pending state?</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
529
530
531</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 529</span>
<span class='kw'>def</span> <span class='id identifier rubyid_pending?'>pending?</span>
<span class='op'>!</span><span class='id identifier rubyid_internal_state'>internal_state</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="resolved?-instance_method">
#<strong>resolved?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Is it in resolved state?</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
535
536
537</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 535</span>
<span class='kw'>def</span> <span class='id identifier rubyid_resolved?'>resolved?</span>
<span class='id identifier rubyid_internal_state'>internal_state</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="state-instance_method">
<span class="overload">#<strong>an_event.state</strong> &#x21d2; <tt>:pending</tt>, <tt>:resolved</tt> </span>
<span class="overload">#<strong>a_future.state</strong> &#x21d2; <tt>:pending</tt>, <tt>:fulfilled</tt>, <tt>:rejected</tt> </span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns its state.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Overloads:</p>
<ul class="overload">
<li class="overload_item">
<span class="signature">#<strong>an_event.state</strong> &#x21d2; <tt>:pending</tt>, <tt>:resolved</tt> </span>
<div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>:pending</tt>, <tt>:resolved</tt>)</span>
</li>
</ul>
</div>
</li>
<li class="overload_item">
<span class="signature">#<strong>a_future.state</strong> &#x21d2; <tt>:pending</tt>, <tt>:fulfilled</tt>, <tt>:rejected</tt> </span>
<div class="docstring">
<div class="discussion">
<p>Both :fulfilled, :rejected implies :resolved.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>:pending</tt>, <tt>:fulfilled</tt>, <tt>:rejected</tt>)</span>
</li>
</ul>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
523
524
525</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 523</span>
<span class='kw'>def</span> <span class='id identifier rubyid_state'>state</span>
<span class='id identifier rubyid_internal_state'>internal_state</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="throttled_by-instance_method">
#<strong>throttled_by</strong>(throttle) {|a| ... } &#x21d2; <tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt>, <tt><span class='object_link'><a href="Event.html" title="Concurrent::Promises::Event (class)">Event</a></span></tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="AbstractEventFuture/ThrottleIntegration.html#throttled_by-instance_method" title="Concurrent::Promises::AbstractEventFuture::ThrottleIntegration#throttled_by (method)">ThrottleIntegration</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>a</span>
<span class='type'>(<tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt>)</span>
&mdash;
<div class='inline'><p>trigger</p>
</div>
</li>
</ul>
<p class="tag_title">Yield Returns:</p>
<ul class="yieldreturn">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt>, <tt><span class='object_link'><a href="Event.html" title="Concurrent::Promises::Event (class)">Event</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt>, <tt><span class='object_link'><a href="Event.html" title="Concurrent::Promises::Event (class)">Event</a></span></tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="to_s-instance_method">
#<strong>to_s</strong> &#x21d2; <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>Returns 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>
&mdash;
<div class='inline'><p>Short string representation.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
599
600
601</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 599</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'>&#39;</span><span class='tstring_content'>%s %s&gt;</span><span class='tstring_end'>&#39;</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_state'>state</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="touch-instance_method">
#<strong>touch</strong> &#x21d2; <tt>self</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Propagates touch. Requests all the delayed futures, which it depends on, to be
executed. This method is called by any other method requiring resolved state, like <span class='object_link'><a href="#wait-instance_method" title="Concurrent::Promises::AbstractEventFuture#wait (method)">#wait</a></span>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>self</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
542
543
544
545</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 542</span>
<span class='kw'>def</span> <span class='id identifier rubyid_touch'>touch</span>
<span class='ivar'>@Promise</span><span class='period'>.</span><span class='id identifier rubyid_touch'>touch</span>
<span class='kw'>self</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="wait-instance_method">
#<strong>wait</strong>(timeout = nil) &#x21d2; <tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt>, <tt>true</tt>, <tt>false</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This function potentially blocks current thread until the Future is resolved.
Be careful it can deadlock. Try to chain instead.</p>
</div>
</div>
<p>Wait (block the Thread) until receiver is <span class='object_link'><a href="#resolved%3F-instance_method" title="Concurrent::Promises::AbstractEventFuture#resolved? (method)">#resolved?</a></span>.
Calls <span class='object_link'><a href="#touch-instance_method" title="Concurrent::Promises::AbstractEventFuture#touch (method)">#touch</a></span>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>timeout</span>
<span class='type'>(<tt>Numeric</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'><p>the maximum time in second to wait.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Future.html" title="Concurrent::Promises::Future (class)">Future</a></span></tt>, <tt>true</tt>, <tt>false</tt>)</span>
&mdash;
<div class='inline'><p>self implies timeout was not used, true implies timeout was used
and it was resolved, false implies it was not resolved within timeout.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
558
559
560
561</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 558</span>
<span class='kw'>def</span> <span class='id identifier rubyid_wait'>wait</span><span class='lparen'>(</span><span class='id identifier rubyid_timeout'>timeout</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_wait_until_resolved'>wait_until_resolved</span><span class='lparen'>(</span><span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
<span class='id identifier rubyid_timeout'>timeout</span> <span class='op'>?</span> <span class='id identifier rubyid_result'>result</span> <span class='op'>:</span> <span class='kw'>self</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="with_default_executor-instance_method">
#<strong>with_default_executor</strong>(executor) &#x21d2; <tt><span class='object_link'><a href="" title="Concurrent::Promises::AbstractEventFuture (class)">AbstractEventFuture</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This method is abstract.</strong>
<div class='inline'></div>
</div>
<p>Crates new object with same class with the executor set as its new default executor.
Any futures depending on it will use the new default executor.</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="" title="Concurrent::Promises::AbstractEventFuture (class)">AbstractEventFuture</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NotImplementedError</tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Event.html#with_default_executor-instance_method" title="Concurrent::Promises::Event#with_default_executor (method)">Event#with_default_executor</a></span></li>
<li><span class='object_link'><a href="Future.html#with_default_executor-instance_method" title="Concurrent::Promises::Future#with_default_executor (method)">Future#with_default_executor</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
663
664
665</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/promises.rb', line 663</span>
<span class='kw'>def</span> <span class='id identifier rubyid_with_default_executor'>with_default_executor</span><span class='lparen'>(</span><span class='id identifier rubyid_executor'>executor</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</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>
View Git Blame Copy Permalink