Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/doc/html/try_mutex.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 18 years ago

added boost
File size: 8.1 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Class try_mutex</title>
5<link rel="stylesheet" href="boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
7<link rel="start" href="index.html" title="The Boost C++ Libraries">
8<link rel="up" href="threads/reference.html#id2534429" title="Header &lt;boost/thread/mutex.hpp&gt;">
9<link rel="prev" href="mutex.html" title="Class mutex">
10<link rel="next" href="timed_mutex.html" title="Class timed_mutex">
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.png (6897 bytes)" 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="mutex.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="threads/reference.html#id2534429"><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="timed_mutex.html"><img src="images/next.png" alt="Next"></a>
24</div>
25<div class="refentry" lang="en">
26<a name="try_mutex"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Class try_mutex</span></h2>
29<p>boost::try_mutex &#8212; <p>The <a href="try_mutex.html" title="Class try_mutex">try_mutex</a> class is a model of the
30                        <a href="threads/concepts.html#threads.concepts.TryMutex" title="TryMutex Concept">TryMutex</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> try_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
41  <span class="emphasis"><em>// <a href="try_mutex.html#try_mutexconstruct-copy-destruct">construct/copy/destruct</a></em></span>
42  <a href="try_mutex.html#id2597718-bb">try_mutex</a>();
43  <a href="try_mutex.html#id2596969-bb">~try_mutex</a>();
44};</pre></div>
45<div class="refsect1" lang="en">
46<a name="id2781196"></a><h2>Description</h2>
47<p>The <a href="try_mutex.html" title="Class try_mutex">try_mutex</a> class is a model of the
48                        <a href="threads/concepts.html#threads.concepts.TryMutex" title="TryMutex Concept">TryMutex</a> concept.
49                        It should be used to synchronize access to shared resources using
50                        <a href="threads/concepts.html#threads.concepts.unspecified-locking-strategy" title="Unspecified Locking Strategy">Unspecified</a>
51                        locking mechanics.</p>
52<p>For classes that model related mutex concepts, see
53                        <a href="mutex.html" title="Class mutex">mutex</a> and <a href="timed_mutex.html" title="Class timed_mutex">timed_mutex</a>.</p>
54<p>For <a href="threads/concepts.html#threads.concepts.recursive-locking-strategy" title="Recursive Locking Strategy">Recursive</a>
55                        locking mechanics, see <a href="recursive_mutex.html" title="Class recursive_mutex">recursive_mutex</a>,
56                        <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>.
57                        </p>
58<p>The <a href="try_mutex.html" title="Class try_mutex">try_mutex</a> class supplies the following typedefs,
59                        which <a href="threads/concepts.html#threads.concepts.lock-models" title="Lock Models">model</a>
60                        the specified locking strategies:
61
62                        </p>
63<div class="informaltable"><table class="table">
64<colgroup>
65<col>
66<col>
67</colgroup>
68<thead><tr>
69<th align="left">Lock Name</th>
70<th align="left">Lock Concept</th>
71</tr></thead>
72<tbody>
73<tr>
74<td align="left">scoped_lock</td>
75<td align="left"><a href="threads/concepts.html#threads.concepts.ScopedLock" title="ScopedLock Concept">ScopedLock</a></td>
76</tr>
77<tr>
78<td align="left">scoped_try_lock</td>
79<td align="left"><a href="threads/concepts.html#threads.concepts.ScopedTryLock" title="ScopedTryLock Concept">ScopedTryLock</a></td>
80</tr>
81</tbody>
82</table></div>
83<p>The <a href="try_mutex.html" title="Class try_mutex">try_mutex</a> class uses an
84                        <a href="threads/concepts.html#threads.concepts.unspecified-locking-strategy" title="Unspecified Locking Strategy">Unspecified</a>
85                        locking strategy, so attempts to recursively lock a <a href="try_mutex.html" title="Class try_mutex">try_mutex</a>
86                        object or attempts to unlock one by threads that don't own a lock on it result in
87                        <span class="bold"><strong>undefined behavior</strong></span>.
88                        This strategy allows implementations to be as efficient as possible
89                        on any given platform. It is, however, recommended that
90                        implementations include debugging support to detect misuse when
91                        <code class="computeroutput">NDEBUG</code> is not defined.</p>
92<p>Like all
93                        <a href="threads/concepts.html#threads.concepts.mutex-models" title="Mutex Models">mutex models</a>
94                        in <span class="bold"><strong>Boost.Threads</strong></span>, <a href="try_mutex.html" title="Class try_mutex">try_mutex</a> leaves the
95                        <a href="threads/concepts.html#threads.concepts.sheduling-policies" title="Scheduling Policies">scheduling policy</a>
96                        as <a href="threads/concepts.html#threads.concepts.unspecified-scheduling-policy" title="Unspecified Policy">Unspecified</a>.
97                        Programmers should make no assumptions about the order in which
98                        waiting threads acquire a lock.</p>
99<div class="refsect2" lang="en">
100<a name="id2781416"></a><h3>
101<a name="try_mutexconstruct-copy-destruct"></a><code class="computeroutput">try_mutex</code> construct/copy/destruct</h3>
102<div class="orderedlist"><ol type="1">
103<li>
104<pre class="literallayout"><a name="id2597718-bb"></a>try_mutex();</pre>
105<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
106
107    Constructs a <a href="try_mutex.html" title="Class try_mutex">try_mutex</a> object.
108                        <br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Postconditions</span></b>:
109
110    <code class="computeroutput">*this</code> is in an unlocked state.
111                        </p>
112</li>
113<li>
114<pre class="literallayout"><a name="id2596969-bb"></a>~try_mutex();</pre>
115<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>:
116
117    Destroys a <a href="try_mutex.html" title="Class try_mutex">try_mutex</a> object.
118                        <br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Requires</span></b>:
119
120    <code class="computeroutput">*this</code> is in an unlocked state.<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Notes</span></b>:
121
122    <span class="bold"><strong>Danger:</strong></span> Destruction of a
123                        locked mutex is a serious programming error resulting in undefined
124                        behavior such as a program crash.</p>
125</li>
126</ol></div>
127</div>
128</div>
129</div>
130<table width="100%"><tr>
131<td align="left"></td>
132<td align="right"><small>Copyright © 2001-2003 William E. Kempf</small></td>
133</tr></table>
134<hr>
135<div class="spirit-nav">
136<a accesskey="p" href="mutex.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="threads/reference.html#id2534429"><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="timed_mutex.html"><img src="images/next.png" alt="Next"></a>
137</div>
138</body>
139</html>
Note: See TracBrowser for help on using the repository browser.