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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<link href="../pool.css" rel="stylesheet" type="text/css">
<title>guard - Auto-lock/unlock-er</title>
</head>
<body>
<img src="../../../../boost.png" width="276" height="86" alt="C++ Boost">
<h1 align="center">guard - Auto-lock/unlock-er</h1>
<h2>Introduction</h2>
<p>detail/guard.hpp provides a type <span class=
"code">guard<Mutex></span> that allows scoped access to the
<span class="code">Mutex</span>'s locking and unlocking operations. It is
used to ensure that a <span class="code">Mutex</span> is unlocked, even if
an exception is thrown.</p>
<h2>Synopsis</h2>
<pre class="code">
namespace details {
namespace pool {
template <typename Mutex>
class guard
{
private:
guard(const guard &);
void operator=(const guard &);
public:
explicit guard(Mutex & mtx);
~guard();
};
} // namespace pool
} // namespace details
</pre>
<h2>Semantics</h2>
<table border align="center" summary="">
<caption>
<em>Symbol Table</em>
</caption>
<tr>
<th>Symbol</th>
<th>Meaning</th>
</tr>
<tr>
<td class="code">T</td>
<td><span class="code">guard<Mutex></span></td>
</tr>
<tr>
<td class="code">m</td>
<td>value of type <span class="code">Mutex &</span></td>
</tr>
<tr>
<td class="code">g</td>
<td>value of type <span class="code">guard<Mutex></span></td>
</tr>
</table><br>
<table border align="center" summary="">
<caption>
<em>Requirements on <span class="code">Mutex</span></em>
</caption>
<tr>
<th>Expression</th>
<th>Return Type</th>
<th>Assertion/Note/Pre/Post-Condition</th>
</tr>
<tr>
<td class="code">m.lock()</td>
<td>not used</td>
<td>Locks the mutex referred to by <span class="code">m</span></td>
</tr>
<tr>
<td class="code">m.unlock()</td>
<td>not used</td>
<td>Unlocks the mutex referred to by <span class="code">m</span></td>
</tr>
</table><br>
<table border align="center" summary="">
<caption>
<em>Requirements satisfied by <span class="code">guard</span></em>
</caption>
<tr>
<th>Expression</th>
<th>Assertion/Note/Pre/Post-Condition</th>
</tr>
<tr>
<td class="code">T(m)</td>
<td>Locks the mutex referred to by <span class="code">m</span>; binds
<span class="code">T(m)</span> to <span class="code">m</span></td>
</tr>
<tr>
<td class="code">(&g)->~T()</td>
<td>Unlocks the mutex that <span class="code">g</span> is bound to</td>
</tr>
</table>
<h2>Example</h2>
<p>Given a (platform-specific) <span class="code">mutex</span> class, we
can wrap code as follows:</p>
<pre class="code">
extern mutex global_lock;
static void f()
{
boost::details::pool::guard<mutex> g(global_lock);
// g's constructor locks "global_lock"
... // do anything:
// throw exceptions
// return
// or just fall through
} // g's destructor unlocks "global_lock"
</pre>
<h2>Dependencies</h2>
<p>None.</p>
<h2>Future Directions</h2>
<p>This header will eventually be replaced by a Boost multithreading
library.</p>
<hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->05
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38516" --></p>
<p><i>Copyright © 2000, 2001 Stephen Cleary (scleary AT jerviswebb DOT
com)</i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
or copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body>
</html>
|
