Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/doc/html/boost/timed_mutex.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 8.7 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Class timed_mutex</title>
5<link rel="stylesheet" href="../boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
7<link rel="start" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
8<link rel="up" href="../thread/reference.html#header.boost.thread.mutex.hpp" title="Header &lt;boost/thread/mutex.hpp&gt;">
9<link rel="prev" href="try_mutex.html" title="Class try_mutex">
10<link rel="next" href="../BOOST_ONCE_INIT.html" title="Macro BOOST_ONCE_INIT">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%">
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
15<td align="center"><a href="../../../index.htm">Home</a></td>
16<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="../../../people/people.htm">People</a></td>
18<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
19<td align="center"><a href="../../../more/index.htm">More</a></td>
20</table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="try_mutex.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../thread/reference.html#header.boost.thread.mutex.hpp"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../BOOST_ONCE_INIT.html"><img src="../images/next.png" alt="Next"></a>
24</div>
25<div class="refentry" lang="en">
26<a name="boost.timed_mutex"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Class timed_mutex</span></h2>
29<p>boost::timed_mutex &#8212; <p>The <a href="timed_mutex.html" title="Class timed_mutex">timed_mutex</a> class is a model of the
30                        <a href="../thread/concepts.html#thread.concepts.TimedMutex" title="TimedMutex Concept">TimedMutex</a> concept.</p></p>
31</div>
32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">
34<span class="bold"><strong>class</strong></span> timed_mutex : <span class="bold"><strong>private</strong></span> boost::noncopyable   <span class="emphasis"><em>// Exposition only</em></span>
35{
36<span class="bold"><strong>public</strong></span>:
37  <span class="emphasis"><em>// types</em></span>
38  <span class="bold"><strong>typedef</strong></span> <span class="emphasis"><em>implementation-defined</em></span> scoped_lock;      
39  <span class="bold"><strong>typedef</strong></span> <span class="emphasis"><em>implementation-defined</em></span> scoped_try_lock;  
40  <span class="bold"><strong>typedef</strong></span> <span class="emphasis"><em>implementation-defined</em></span> scoped_timed_lock;
41
42  <span class="emphasis"><em>// <a href="timed_mutex.html#boost.timed_mutexconstruct-copy-destruct">construct/copy/destruct</a></em></span>
43  <a href="timed_mutex.html#id1254402-bb">timed_mutex</a>();
44  <a href="timed_mutex.html#id1284622-bb">~timed_mutex</a>();
45};</pre></div>
46<div class="refsect1" lang="en">
47<a name="id1739468"></a><h2>Description</h2>
48<p>The <a href="timed_mutex.html" title="Class timed_mutex">timed_mutex</a> class is a model of the
49                        <a href="../thread/concepts.html#thread.concepts.TimedMutex" title="TimedMutex Concept">TimedMutex</a> concept.
50                        It should be used to synchronize access to shared resources using
51                        <a href="../thread/concepts.html#thread.concepts.unspecified-locking-strategy" title="Unspecified Locking Strategy">Unspecified</a>
52                        locking mechanics.</p>
53<p>For classes that model related mutex concepts, see
54                        <a href="mutex.html" title="Class mutex">mutex</a> and <a href="try_mutex.html" title="Class try_mutex">try_mutex</a>.</p>
55<p>For <a href="../thread/concepts.html#thread.concepts.recursive-locking-strategy" title="Recursive Locking Strategy">Recursive</a>
56                        locking mechanics, see <a href="recursive_mutex.html" title="Class recursive_mutex">recursive_mutex</a>,
57                        <a href="recursive_try_mutex.html" title="Class recursive_try_mutex">recursive_try_mutex</a>, and <a href="recursive_timed_mutex.html" title="Class recursive_timed_mutex">recursive_timed_mutex</a>.
58                        </p>
59<p>The <a href="timed_mutex.html" title="Class timed_mutex">timed_mutex</a> class supplies the following typedefs,
60                        which <a href="../thread/concepts.html#thread.concepts.lock-models" title="Lock Models">model</a>
61                        the specified locking strategies:
62
63                        </p>
64<div class="informaltable"><table class="table">
65<colgroup>
66<col>
67<col>
68</colgroup>
69<thead><tr>
70<th align="left">Lock Name</th>
71<th align="left">Lock Concept</th>
72</tr></thead>
73<tbody>
74<tr>
75<td align="left">scoped_lock</td>
76<td align="left"><a href="../thread/concepts.html#thread.concepts.ScopedLock" title="ScopedLock Concept">ScopedLock</a></td>
77</tr>
78<tr>
79<td align="left">scoped_try_lock</td>
80<td align="left"><a href="../thread/concepts.html#thread.concepts.ScopedTryLock" title="ScopedTryLock Concept">ScopedTryLock</a></td>
81</tr>
82<tr>
83<td align="left">scoped_timed_lock</td>
84<td align="left"><a href="../thread/concepts.html#thread.concepts.ScopedTimedLock" title="ScopedTimedLock Concept">ScopedTimedLock</a></td>
85</tr>
86</tbody>
87</table></div>
88<p>
89                        </p>
90<p>The <a href="timed_mutex.html" title="Class timed_mutex">timed_mutex</a> class uses an
91                        <a href="../thread/concepts.html#thread.concepts.unspecified-locking-strategy" title="Unspecified Locking Strategy">Unspecified</a>
92                        locking strategy, so attempts to recursively lock a <a href="timed_mutex.html" title="Class timed_mutex">timed_mutex</a>
93                        object or attempts to unlock one by threads that don't own a lock on it result in
94                        <span class="bold"><strong>undefined behavior</strong></span>.
95                        This strategy allows implementations to be as efficient as possible
96                        on any given platform. It is, however, recommended that
97                        implementations include debugging support to detect misuse when
98                        <code class="computeroutput">NDEBUG</code> is not defined.</p>
99<p>Like all
100                        <a href="../thread/concepts.html#thread.concepts.mutex-models" title="Mutex Models">mutex models</a>
101                        in  <span class="bold"><strong>Boost.Thread</strong></span>, <a href="timed_mutex.html" title="Class timed_mutex">timed_mutex</a> leaves the
102                        <a href="../thread/concepts.html#thread.concepts.sheduling-policies" title="Scheduling Policies">scheduling policy</a>
103                        as <a href="../thread/concepts.html#thread.concepts.unspecified-scheduling-policy" title="Unspecified Policy">Unspecified</a>.
104                        Programmers should make no assumptions about the order in which
105                        waiting threads acquire a lock.</p>
106<div class="refsect2" lang="en">
107<a name="id1739732"></a><h3>
108<a name="boost.timed_mutexconstruct-copy-destruct"></a><code class="computeroutput">timed_mutex</code> construct/copy/destruct</h3>
109<div class="orderedlist"><ol type="1">
110<li>
111<pre class="literallayout"><a name="id1254402-bb"></a>timed_mutex();</pre>
112<div class="variablelist"><table border="0">
113<col align="left" valign="top">
114<tbody>
115<tr>
116<td>
117<span class="term">Effects:</span></td>
118<td>Constructs a <a href="timed_mutex.html" title="Class timed_mutex">timed_mutex</a> object.
119                        </td>
120</tr>
121<tr>
122<td>
123<span class="term">Postconditions:</span></td>
124<td>
125<code class="computeroutput">*this</code> is in an unlocked state.
126                        </td>
127</tr>
128</tbody>
129</table></div>
130</li>
131<li>
132<pre class="literallayout"><a name="id1284622-bb"></a>~timed_mutex();</pre>
133<div class="variablelist"><table border="0">
134<col align="left" valign="top">
135<tbody>
136<tr>
137<td>
138<span class="term">Effects:</span></td>
139<td>Destroys a <a href="timed_mutex.html" title="Class timed_mutex">timed_mutex</a> object.</td>
140</tr>
141<tr>
142<td>
143<span class="term">Requires:</span></td>
144<td>
145<code class="computeroutput">*this</code> is in an unlocked state.</td>
146</tr>
147<tr>
148<td>
149<span class="term">Notes:</span></td>
150<td>
151<span class="bold"><strong>Danger:</strong></span> Destruction of a
152                        locked mutex is a serious programming error resulting in undefined
153                        behavior such as a program crash.</td>
154</tr>
155</tbody>
156</table></div>
157</li>
158</ol></div>
159</div>
160</div>
161</div>
162<table width="100%"><tr>
163<td align="left"></td>
164<td align="right"><small>Copyright © 2001-2003 William E. Kempf</small></td>
165</tr></table>
166<hr>
167<div class="spirit-nav">
168<a accesskey="p" href="try_mutex.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../thread/reference.html#header.boost.thread.mutex.hpp"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../BOOST_ONCE_INIT.html"><img src="../images/next.png" alt="Next"></a>
169</div>
170</body>
171</html>
Note: See TracBrowser for help on using the repository browser.