/
Synchronization.html
197 lines (121 loc) · 8.23 KB
/
Synchronization.html
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Concurrent::Synchronization
— 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::Synchronization";
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 (S)</a> »
<span class='title'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span>
»
<span class="title">Synchronization</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>Module: Concurrent::Synchronization
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/concurrent/synchronization.rb<span class="defines">,<br />
lib/concurrent/synchronization/lock.rb,<br /> lib/concurrent/synchronization/object.rb,<br /> lib/concurrent/synchronization/volatile.rb,<br /> lib/concurrent/synchronization/condition.rb,<br /> lib/concurrent/synchronization/mri_object.rb,<br /> lib/concurrent/synchronization/rbx_object.rb,<br /> lib/concurrent/synchronization/jruby_object.rb,<br /> lib/concurrent/synchronization/abstract_object.rb,<br /> lib/concurrent/synchronization/abstract_struct.rb,<br /> lib/concurrent/synchronization/lockable_object.rb,<br /> lib/concurrent/synchronization/truffleruby_object.rb,<br /> lib/concurrent/synchronization/rbx_lockable_object.rb,<br /> lib/concurrent/synchronization/jruby_lockable_object.rb,<br /> lib/concurrent/synchronization/mutex_lockable_object.rb,<br /> lib/concurrent/synchronization/abstract_lockable_object.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>noinspection RubyInstanceVariableNamingConvention</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Synchronization/JRubyAttrVolatile.html" title="Concurrent::Synchronization::JRubyAttrVolatile (module)">JRubyAttrVolatile</a></span>, <span class='object_link'><a href="Synchronization/MriAttrVolatile.html" title="Concurrent::Synchronization::MriAttrVolatile (module)">MriAttrVolatile</a></span>, <span class='object_link'><a href="Synchronization/RbxAttrVolatile.html" title="Concurrent::Synchronization::RbxAttrVolatile (module)">RbxAttrVolatile</a></span>, <span class='object_link'><a href="Synchronization/TruffleRubyAttrVolatile.html" title="Concurrent::Synchronization::TruffleRubyAttrVolatile (module)">TruffleRubyAttrVolatile</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Synchronization/Condition.html" title="Concurrent::Synchronization::Condition (class)">Condition</a></span>, <span class='object_link'><a href="Synchronization/Lock.html" title="Concurrent::Synchronization::Lock (class)">Lock</a></span>, <span class='object_link'><a href="Synchronization/Object.html" title="Concurrent::Synchronization::Object (class)">Object</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="Volatile-constant" class="">Volatile =
<div class="docstring">
<div class="discussion">
<p>Volatile adds the attr_volatile class method when included.</p>
<p>foo = Foo.new
foo.bar
=> 1
foo.bar = 2
=> 2</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>Foo</span>
<span class='id identifier rubyid_include'>include</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::Synchronization (module)">Synchronization</a></span></span><span class='op'>::</span><span class='const'>Volatile</span>
<span class='id identifier rubyid_attr_volatile'>attr_volatile</span> <span class='symbol'>:bar</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_bar'>bar</span> <span class='op'>=</span> <span class='int'>1</span>
<span class='kw'>end</span>
<span class='kw'>end</span></code></pre>
</div>
</div>
</dt>
<dd><pre class="code"><span class='kw'>case</span>
<span class='kw'>when</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_on_cruby?'>on_cruby?</span>
<span class='const'><span class='object_link'><a href="Synchronization/MriAttrVolatile.html" title="Concurrent::Synchronization::MriAttrVolatile (module)">MriAttrVolatile</a></span></span>
<span class='kw'>when</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_on_jruby?'>on_jruby?</span>
<span class='const'><span class='object_link'><a href="Synchronization/JRubyAttrVolatile.html" title="Concurrent::Synchronization::JRubyAttrVolatile (module)">JRubyAttrVolatile</a></span></span>
<span class='kw'>when</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_on_rbx?'>on_rbx?</span>
<span class='const'><span class='object_link'><a href="Synchronization/RbxAttrVolatile.html" title="Concurrent::Synchronization::RbxAttrVolatile (module)">RbxAttrVolatile</a></span></span>
<span class='kw'>when</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_on_truffleruby?'>on_truffleruby?</span>
<span class='const'><span class='object_link'><a href="Synchronization/TruffleRubyAttrVolatile.html" title="Concurrent::Synchronization::TruffleRubyAttrVolatile (module)">TruffleRubyAttrVolatile</a></span></span>
<span class='kw'>else</span>
<span class='const'><span class='object_link'><a href="Synchronization/MriAttrVolatile.html" title="Concurrent::Synchronization::MriAttrVolatile (module)">MriAttrVolatile</a></span></span>
<span class='kw'>end</span></pre></dd>
</dl>
</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>