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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>tbb::spin_rw_mutex_v3::scoped_lock Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00249.html">tbb</a></li><li class="navelem"><a class="el" href="a00155.html">spin_rw_mutex_v3</a></li><li class="navelem"><a class="el" href="a00144.html">scoped_lock</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> |
<a href="a00320.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">tbb::spin_rw_mutex_v3::scoped_lock Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The scoped locking pattern.
<a href="a00144.html#details">More...</a></p>
<p><code>#include <spin_rw_mutex.h></code></p>
<div class="dynheader">
Inheritance diagram for tbb::spin_rw_mutex_v3::scoped_lock:</div>
<div class="dyncontent">
<div class="center">
<img src="a00144.png" usemap="#tbb::spin_rw_mutex_v3::scoped_lock_map" alt=""/>
<map id="tbb::spin_rw_mutex_v3::scoped_lock_map" name="tbb::spin_rw_mutex_v3::scoped_lock_map">
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a285b355121772c874a7ecaaf4d347224"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#a285b355121772c874a7ecaaf4d347224">scoped_lock</a> ()</td></tr>
<tr class="memdesc:a285b355121772c874a7ecaaf4d347224"><td class="mdescLeft"> </td><td class="mdescRight">Construct lock that has not acquired a mutex. <a href="#a285b355121772c874a7ecaaf4d347224">More...</a><br/></td></tr>
<tr class="separator:a285b355121772c874a7ecaaf4d347224"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a2e15358575f7651446bca13a5a2674"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a2e15358575f7651446bca13a5a2674"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#a0a2e15358575f7651446bca13a5a2674">scoped_lock</a> (<a class="el" href="a00155.html">spin_rw_mutex</a> &m, bool write=true)</td></tr>
<tr class="memdesc:a0a2e15358575f7651446bca13a5a2674"><td class="mdescLeft"> </td><td class="mdescRight">Acquire lock on given mutex. <br/></td></tr>
<tr class="separator:a0a2e15358575f7651446bca13a5a2674"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c27ca2e0c9db960a9a7430082ff7edd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c27ca2e0c9db960a9a7430082ff7edd"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#a5c27ca2e0c9db960a9a7430082ff7edd">~scoped_lock</a> ()</td></tr>
<tr class="memdesc:a5c27ca2e0c9db960a9a7430082ff7edd"><td class="mdescLeft"> </td><td class="mdescRight">Release lock (if lock is held). <br/></td></tr>
<tr class="separator:a5c27ca2e0c9db960a9a7430082ff7edd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d49df365396ab314e78ba07c6b96433"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6d49df365396ab314e78ba07c6b96433"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#a6d49df365396ab314e78ba07c6b96433">acquire</a> (<a class="el" href="a00155.html">spin_rw_mutex</a> &m, bool write=true)</td></tr>
<tr class="memdesc:a6d49df365396ab314e78ba07c6b96433"><td class="mdescLeft"> </td><td class="mdescRight">Acquire lock on given mutex. <br/></td></tr>
<tr class="separator:a6d49df365396ab314e78ba07c6b96433"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afbe5de57eadc457518df7a1bb0d30c00"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#afbe5de57eadc457518df7a1bb0d30c00">upgrade_to_writer</a> ()</td></tr>
<tr class="memdesc:afbe5de57eadc457518df7a1bb0d30c00"><td class="mdescLeft"> </td><td class="mdescRight">Upgrade reader to become a writer. <a href="#afbe5de57eadc457518df7a1bb0d30c00">More...</a><br/></td></tr>
<tr class="separator:afbe5de57eadc457518df7a1bb0d30c00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99e279a995a51abfb87b865e886949f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99e279a995a51abfb87b865e886949f8"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#a99e279a995a51abfb87b865e886949f8">release</a> ()</td></tr>
<tr class="memdesc:a99e279a995a51abfb87b865e886949f8"><td class="mdescLeft"> </td><td class="mdescRight">Release lock. <br/></td></tr>
<tr class="separator:a99e279a995a51abfb87b865e886949f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa693c05221d977856a98270a255fe5df"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa693c05221d977856a98270a255fe5df"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#aa693c05221d977856a98270a255fe5df">downgrade_to_reader</a> ()</td></tr>
<tr class="memdesc:aa693c05221d977856a98270a255fe5df"><td class="mdescLeft"> </td><td class="mdescRight">Downgrade writer to become a reader. <br/></td></tr>
<tr class="separator:aa693c05221d977856a98270a255fe5df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf17ada91882fd70f139c503c0220f16"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf17ada91882fd70f139c503c0220f16"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#abf17ada91882fd70f139c503c0220f16">try_acquire</a> (<a class="el" href="a00155.html">spin_rw_mutex</a> &m, bool write=true)</td></tr>
<tr class="memdesc:abf17ada91882fd70f139c503c0220f16"><td class="mdescLeft"> </td><td class="mdescRight">Try acquire lock on given mutex. <br/></td></tr>
<tr class="separator:abf17ada91882fd70f139c503c0220f16"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a8d70c5a2348e30a6979bfbf677328dc4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d70c5a2348e30a6979bfbf677328dc4"></a>
<a class="el" href="a00155.html">spin_rw_mutex</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#a8d70c5a2348e30a6979bfbf677328dc4">mutex</a></td></tr>
<tr class="memdesc:a8d70c5a2348e30a6979bfbf677328dc4"><td class="mdescLeft"> </td><td class="mdescRight">The pointer to the current mutex that is held, or NULL if no mutex is held. <br/></td></tr>
<tr class="separator:a8d70c5a2348e30a6979bfbf677328dc4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acfd129dc5106ad1129ba803e67311050"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#acfd129dc5106ad1129ba803e67311050">is_writer</a></td></tr>
<tr class="memdesc:acfd129dc5106ad1129ba803e67311050"><td class="mdescLeft"> </td><td class="mdescRight">If mutex!=NULL, then is_writer is true if holding a writer lock, false if holding a reader lock. <a href="#acfd129dc5106ad1129ba803e67311050">More...</a><br/></td></tr>
<tr class="separator:acfd129dc5106ad1129ba803e67311050"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ad3297bb1f91f2e12c4f3fb3e68f135bb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3297bb1f91f2e12c4f3fb3e68f135bb"></a>
class </td><td class="memItemRight" valign="bottom"><b>tbb::interface8::internal::x86_rtm_rw_mutex</b></td></tr>
<tr class="separator:ad3297bb1f91f2e12c4f3fb3e68f135bb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The scoped locking pattern. </p>
<p>It helps to avoid the common problem of forgetting to release lock. It also nicely provides the "node" for queuing locks. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a285b355121772c874a7ecaaf4d347224"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">tbb::spin_rw_mutex_v3::scoped_lock::scoped_lock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct lock that has not acquired a mutex. </p>
<p>Equivalent to zero-initialization of *this. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afbe5de57eadc457518df7a1bb0d30c00"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool tbb::spin_rw_mutex_v3::scoped_lock::upgrade_to_writer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Upgrade reader to become a writer. </p>
<p>Returns whether the upgrade happened without releasing and re-acquiring the lock </p>
<p>References <a class="el" href="a00144.html#acfd129dc5106ad1129ba803e67311050">is_writer</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="acfd129dc5106ad1129ba803e67311050"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool tbb::spin_rw_mutex_v3::scoped_lock::is_writer</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>If mutex!=NULL, then is_writer is true if holding a writer lock, false if holding a reader lock. </p>
<p>Not defined if not holding a lock. </p>
<p>Referenced by <a class="el" href="a00144.html#a6d49df365396ab314e78ba07c6b96433">acquire()</a>, <a class="el" href="a00144.html#aa693c05221d977856a98270a255fe5df">downgrade_to_reader()</a>, <a class="el" href="a00144.html#a99e279a995a51abfb87b865e886949f8">release()</a>, <a class="el" href="a00144.html#abf17ada91882fd70f139c503c0220f16">try_acquire()</a>, and <a class="el" href="a00144.html#afbe5de57eadc457518df7a1bb0d30c00">upgrade_to_writer()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>spin_rw_mutex.h</li>
</ul>
</div><!-- contents -->
<hr>
<p></p>
Copyright © 2005-2018 Intel Corporation. All Rights Reserved.
<p></p>
Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
registered trademarks or trademarks of Intel Corporation or its
subsidiaries in the United States and other countries.
<p></p>
* Other names and brands may be claimed as the property of others.
|
