diff options
Diffstat (limited to 'doc/html/condition.html')
| -rw-r--r-- | doc/html/condition.html | 70 |
1 files changed, 35 insertions, 35 deletions
diff --git a/doc/html/condition.html b/doc/html/condition.html index 726758a1b6..a93f244c38 100644 --- a/doc/html/condition.html +++ b/doc/html/condition.html @@ -3,9 +3,9 @@ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>Class condition</title> <link rel="stylesheet" href="boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> <link rel="start" href="index.html" title="The Boost C++ Libraries"> -<link rel="up" href="threads/reference.html#id1105286" title="Header <boost/thread/condition.hpp>"> +<link rel="up" href="threads/reference.html#id2450200" title="Header <boost/thread/condition.hpp>"> <link rel="prev" href="barrier.html" title="Class barrier"> <link rel="next" href="lock_error.html" title="Class lock_error"> </head> @@ -20,7 +20,7 @@ </table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="barrier.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="threads/reference.html#id1105286"><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="lock_error.html"><img src="images/next.png" alt="Next"></a> +<a accesskey="p" href="barrier.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="threads/reference.html#id2450200"><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="lock_error.html"><img src="images/next.png" alt="Next"></a> </div> <div class="refentry" lang="en"> <a name="condition"></a><div class="titlepage"></div> @@ -35,24 +35,24 @@ <span class="bold"><strong>class</strong></span> condition : <span class="bold"><strong>private</strong></span> boost::noncopyable <span class="emphasis"><em>// Exposition only</em></span> { <span class="bold"><strong>public</strong></span>: - <span class="emphasis"><em>// <a href="condition.html#conditionconstruct-copy-destruct">construct/copy/destruct</a></em></span> - <a href="condition.html#id1184057-bb">condition</a>(); - <a href="condition.html#id725455-bb">~condition</a>(); - - <span class="emphasis"><em>// <a href="condition.html#id1285372-bb">notification</a></em></span> - <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="condition.html#id1280071-bb">notify_one</a>(); - <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="condition.html#id1216857-bb">notify_all</a>(); - - <span class="emphasis"><em>// <a href="condition.html#id1136016-bb">waiting</a></em></span> - <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock> <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="condition.html#id1145318-bb">wait</a>(ScopedLock&); - <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock, <span class="bold"><strong>typename</strong></span> Pred> <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="condition.html#id1007637-bb">wait</a>(ScopedLock&, Pred); - <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock> - <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="condition.html#id1281036-bb">timed_wait</a>(ScopedLock&, <span class="bold"><strong>const</strong></span> <a href="xtime.html" title="Struct xtime">boost::xtime</a>&); - <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock, <span class="bold"><strong>typename</strong></span> Pred> - <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="condition.html#id1171333-bb">timed_wait</a>(ScopedLock&, Pred); + <span class="emphasis"><em>// <a href="condition.html#conditionconstruct-copy-destruct">construct/copy/destruct</a></em></span> + <a href="condition.html#id2531211-bb">condition</a>(); + <a href="condition.html#id2604889-bb">~condition</a>(); + + <span class="emphasis"><em>// <a href="condition.html#id2616531-bb">notification</a></em></span> + <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="condition.html#id2534198-bb">notify_one</a>(); + <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="condition.html#id2617876-bb">notify_all</a>(); + + <span class="emphasis"><em>// <a href="condition.html#id2616162-bb">waiting</a></em></span> + <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock> <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="condition.html#id2575301-bb">wait</a>(ScopedLock&); + <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock, <span class="bold"><strong>typename</strong></span> Pred> <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="condition.html#id2450378-bb">wait</a>(ScopedLock&, Pred); + <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="condition.html#id2592886-bb">timed_wait</a>(ScopedLock&, <span class="bold"><strong>const</strong></span> <a href="xtime.html" title="Struct xtime">boost::xtime</a>&); + <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock, <span class="bold"><strong>typename</strong></span> Pred> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="condition.html#id2529517-bb">timed_wait</a>(ScopedLock&, Pred); };</pre></div> <div class="refsect1" lang="en"> -<a name="id1360582"></a><h2>Description</h2> +<a name="id2779416"></a><h2>Description</h2> <p>A <a href="condition.html" title="Class condition">condition</a> object is always used in conjunction with a <a href="threads/concepts.html#threads.concepts.mutexes" title="Mutexes">mutex</a> object (an object whose type is a model of a <a href="threads/concepts.html#threads.concepts.Mutex" title="Mutex Concept">Mutex</a> or one of its @@ -68,24 +68,24 @@ <a href="condition.html" title="Class condition">condition</a> object's wait functions.</p> <p>The <a href="condition.html" title="Class condition">condition</a> type is often used to implement the Monitor Object and other important patterns (see - and ). Monitors are one + [<span class="citation"><a href="threads.html#threads.bib.SchmidtStalRohnertBuschmann">SchmidtStalRohnertBuschmann</a></span>] and [<span class="citation"><a href="threads.html#threads.bib.Hoare74">Hoare74</a></span>]). Monitors are one of the most important patterns for creating reliable multithreaded programs.</p> <p>See <a href="threads.html#threads.glossary" title="Glossary">Glossary</a> for definitions of <a href="threads.html#threads.glossary.thread-state">thread states</a> blocked and ready. Note that "waiting" is a synonym for blocked.</p> <div class="refsect2" lang="en"> -<a name="id1360688"></a><h3> +<a name="id2779548"></a><h3> <a name="conditionconstruct-copy-destruct"></a><code class="computeroutput">condition</code> construct/copy/destruct</h3> <div class="orderedlist"><ol type="1"> <li> -<pre class="literallayout"><a name="id1184057-bb"></a>condition();</pre> +<pre class="literallayout"><a name="id2531211-bb"></a>condition();</pre> <p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>: Constructs a <a href="condition.html" title="Class condition">condition</a> object.</p> </li> <li> -<pre class="literallayout"><a name="id725455-bb"></a>~condition();</pre> +<pre class="literallayout"><a name="id2604889-bb"></a>~condition();</pre> <p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>: Destroys <code class="computeroutput">*this</code>.</p> @@ -93,11 +93,11 @@ </ol></div> </div> <div class="refsect2" lang="en"> -<a name="id1360768"></a><h3> -<a name="id1285372-bb"></a><code class="computeroutput">condition</code> notification</h3> +<a name="id2779628"></a><h3> +<a name="id2616531-bb"></a><code class="computeroutput">condition</code> notification</h3> <div class="orderedlist"><ol type="1"> <li> -<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id1280071-bb"></a>notify_one();</pre> +<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2534198-bb"></a>notify_one();</pre> <p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>: If there is a thread waiting on <code class="computeroutput">*this</code>, @@ -111,7 +111,7 @@ object's wait functions.)</p> </li> <li> -<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id1216857-bb"></a>notify_all();</pre> +<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2617876-bb"></a>notify_all();</pre> <p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>: Change the state of all threads waiting on @@ -121,11 +121,11 @@ </ol></div> </div> <div class="refsect2" lang="en"> -<a name="id1360892"></a><h3> -<a name="id1136016-bb"></a><code class="computeroutput">condition</code> waiting</h3> +<a name="id2779754"></a><h3> +<a name="id2616162-bb"></a><code class="computeroutput">condition</code> waiting</h3> <div class="orderedlist"><ol type="1"> <li> -<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock> <span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id1145318-bb"></a>wait(ScopedLock& lock);</pre> +<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock> <span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2575301-bb"></a>wait(ScopedLock& lock);</pre> <p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Requires</span></b>: <code class="computeroutput">ScopedLock</code> meets the <a href="threads/concepts.html#threads.concepts.ScopedLock" title="ScopedLock Concept">ScopedLock</a> @@ -142,7 +142,7 @@ </li> <li> <pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock, <span class="bold"><strong>typename</strong></span> Pred> - <span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id1007637-bb"></a>wait(ScopedLock& lock, Pred pred);</pre> + <span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2450378-bb"></a>wait(ScopedLock& lock, Pred pred);</pre> <p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Requires</span></b>: <code class="computeroutput">ScopedLock</code> meets the <a href="threads/concepts.html#threads.concepts.ScopedLock" title="ScopedLock Concept">ScopedLock</a> @@ -157,7 +157,7 @@ </li> <li> <pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock> - <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id1281036-bb"></a>timed_wait(ScopedLock& lock, <span class="bold"><strong>const</strong></span> <a href="xtime.html" title="Struct xtime">boost::xtime</a>& xt);</pre> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id2592886-bb"></a>timed_wait(ScopedLock& lock, <span class="bold"><strong>const</strong></span> <a href="xtime.html" title="Struct xtime">boost::xtime</a>& xt);</pre> <p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Requires</span></b>: <code class="computeroutput">ScopedLock</code> meets the <a href="threads/concepts.html#threads.concepts.ScopedLock" title="ScopedLock Concept">ScopedLock</a> @@ -177,7 +177,7 @@ </li> <li> <pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> ScopedLock, <span class="bold"><strong>typename</strong></span> Pred> - <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id1171333-bb"></a>timed_wait(ScopedLock& lock, Pred pred);</pre> + <span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id2529517-bb"></a>timed_wait(ScopedLock& lock, Pred pred);</pre> <p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Requires</span></b>: <code class="computeroutput">ScopedLock</code> meets the <a href="threads/concepts.html#threads.concepts.ScopedLock" title="ScopedLock Concept">ScopedLock</a> @@ -197,13 +197,13 @@ </div> </div> </div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<table width="100%"><tr> <td align="left"></td> <td align="right"><small>Copyright © 2001-2003 William E. Kempf</small></td> </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="barrier.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="threads/reference.html#id1105286"><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="lock_error.html"><img src="images/next.png" alt="Next"></a> +<a accesskey="p" href="barrier.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="threads/reference.html#id2450200"><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="lock_error.html"><img src="images/next.png" alt="Next"></a> </div> </body> </html> |