Skip to content

Commit 6da166a

Browse files
pitr-chpitr-ch
committed
Add 1.1.7 documentation
1 parent 6b803f2 commit 6da166a

File tree

176 files changed

+157478
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

176 files changed

+157478
-0
lines changed

‎docs/1.1.7/Concurrent.html

+3,205
Large diffs are not rendered by default.

‎docs/1.1.7/Concurrent/Actor.html

+1,300
Large diffs are not rendered by default.

‎docs/1.1.7/Concurrent/Actor/AbstractContext.html

+2,554
Large diffs are not rendered by default.

‎docs/1.1.7/Concurrent/Actor/ActorTerminated.html

+669
Large diffs are not rendered by default.

‎docs/1.1.7/Concurrent/Actor/Behaviour.html

+830
Large diffs are not rendered by default.

‎docs/1.1.7/Concurrent/Actor/Behaviour/Abstract.html

+2,019
Large diffs are not rendered by default.

‎docs/1.1.7/Concurrent/Actor/Behaviour/Awaits.html

+248
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,248 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>
7+
Class: Concurrent::Actor::Behaviour::Awaits
8+
9+
&mdash; Concurrent Ruby
10+
11+
</title>
12+
13+
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
14+
15+
<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
16+
17+
<script type="text/javascript">
18+
pathId = "Concurrent::Actor::Behaviour::Awaits";
19+
relpath = '../../../';
20+
</script>
21+
22+
23+
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
24+
25+
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
26+
27+
28+
</head>
29+
<body>
30+
<div class="nav_wrap">
31+
<iframe id="nav" src="../../../class_list.html?1"></iframe>
32+
<div id="resizer"></div>
33+
</div>
34+
35+
<div id="main" tabindex="-1">
36+
<div id="header">
37+
<div id="menu">
38+
39+
<a href="../../../_index.html">Index (A)</a> &raquo;
40+
<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="../../Actor.html" title="Concurrent::Actor (module)">Actor</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Behaviour.html" title="Concurrent::Actor::Behaviour (module)">Behaviour</a></span></span>
41+
&raquo;
42+
<span class="title">Awaits</span>
43+
44+
</div>
45+
46+
<div id="search">
47+
48+
<a class="full_list_link" id="class_list_link"
49+
href="../../../class_list.html">
50+
51+
<svg width="24" height="24">
52+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55+
</svg>
56+
</a>
57+
58+
</div>
59+
<div class="clear"></div>
60+
</div>
61+
62+
<div id="content"><h1>Class: Concurrent::Actor::Behaviour::Awaits
63+
64+
65+
66+
</h1>
67+
<div class="box_info">
68+
69+
<dl>
70+
<dt>Inherits:</dt>
71+
<dd>
72+
<span class="inheritName"><span class='object_link'><a href="Abstract.html" title="Concurrent::Actor::Behaviour::Abstract (class)">Abstract</a></span></span>
73+
74+
<ul class="fullTree">
75+
<li>Object</li>
76+
77+
<li class="next"><span class='object_link'><a href="Abstract.html" title="Concurrent::Actor::Behaviour::Abstract (class)">Abstract</a></span></li>
78+
79+
<li class="next">Concurrent::Actor::Behaviour::Awaits</li>
80+
81+
</ul>
82+
<a href="#" class="inheritanceTree">show all</a>
83+
84+
</dd>
85+
</dl>
86+
87+
88+
89+
90+
91+
92+
93+
94+
95+
96+
97+
<dl>
98+
<dt>Defined in:</dt>
99+
<dd>lib/concurrent-ruby-edge/concurrent/actor/behaviour/awaits.rb</dd>
100+
</dl>
101+
102+
</div>
103+
104+
<h2>Overview</h2><div class="docstring">
105+
<div class="discussion">
106+
<p>Accepts <code>:await</code> messages. Which allows to wait on Actor to process all previously send
107+
messages.</p>
108+
109+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_actor'>actor</span> <span class='op'>&lt;&lt;</span> <span class='symbol'>:a</span> <span class='op'>&lt;&lt;</span> <span class='symbol'>:b</span>
110+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_ask'>ask</span><span class='lparen'>(</span><span class='symbol'>:await</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span> <span class='comment'># blocks until :a and :b are processed
111+
</span></code></pre>
112+
113+
114+
</div>
115+
</div>
116+
<div class="tags">
117+
118+
119+
</div>
120+
121+
122+
123+
124+
125+
126+
127+
<h2>
128+
Instance Method Summary
129+
<small><a href="#" class="summary_toggle">collapse</a></small>
130+
</h2>
131+
132+
<ul class="summary">
133+
134+
<li class="public ">
135+
<span class="summary_signature">
136+
137+
<a href="#on_envelope-instance_method" title="#on_envelope (instance method)">#<strong>on_envelope</strong>(envelope) &#x21d2; undocumented </a>
138+
139+
140+
141+
</span>
142+
143+
144+
145+
146+
147+
148+
149+
150+
151+
<span class="summary_desc"><div class='inline'></div></span>
152+
153+
</li>
154+
155+
156+
</ul>
157+
158+
159+
160+
161+
162+
163+
164+
165+
166+
167+
168+
<div id="constructor_details" class="method_details_list">
169+
<h2>Constructor Details</h2>
170+
171+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Abstract.html#initialize-instance_method" title="Concurrent::Actor::Behaviour::Abstract#initialize (method)">Concurrent::Actor::Behaviour::Abstract</a></span></p>
172+
173+
</div>
174+
175+
176+
<div id="instance_method_details" class="method_details_list">
177+
<h2>Instance Method Details</h2>
178+
179+
180+
<div class="method_details first">
181+
<h3 class="signature first" id="on_envelope-instance_method">
182+
183+
#<strong>on_envelope</strong>(envelope) &#x21d2; <tt>undocumented</tt>
184+
185+
186+
187+
188+
189+
</h3><div class="docstring">
190+
<div class="discussion">
191+
192+
193+
</div>
194+
</div>
195+
<div class="tags">
196+
197+
198+
</div><table class="source_code">
199+
<tr>
200+
<td>
201+
<pre class="lines">
202+
203+
204+
11
205+
12
206+
13
207+
14
208+
15
209+
16
210+
17</pre>
211+
</td>
212+
<td>
213+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby-edge/concurrent/actor/behaviour/awaits.rb', line 11</span>
214+
215+
<span class='kw'>def</span> <span class='id identifier rubyid_on_envelope'>on_envelope</span><span class='lparen'>(</span><span class='id identifier rubyid_envelope'>envelope</span><span class='rparen'>)</span>
216+
<span class='kw'>if</span> <span class='id identifier rubyid_envelope'>envelope</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>==</span> <span class='symbol'>:await</span>
217+
<span class='kw'>true</span>
218+
<span class='kw'>else</span>
219+
<span class='id identifier rubyid_pass'>pass</span> <span class='id identifier rubyid_envelope'>envelope</span>
220+
<span class='kw'>end</span>
221+
<span class='kw'>end</span></pre>
222+
</td>
223+
</tr>
224+
</table>
225+
</div>
226+
227+
</div>
228+
229+
</div>
230+
231+
<div id="footer">
232+
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_blank">yard</a>.
233+
</div>
234+
235+
<script>
236+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
237+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
238+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
239+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
240+
241+
ga('create', 'UA-57940973-1', 'auto');
242+
ga('send', 'pageview');
243+
244+
</script>
245+
246+
</div>
247+
</body>
248+
</html>

0 commit comments

Comments
 (0)