summaryrefslogtreecommitdiff
path: root/doc/html/boost/interprocess/interprocess_condition_any.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/interprocess/interprocess_condition_any.html')
-rw-r--r--doc/html/boost/interprocess/interprocess_condition_any.html117
1 files changed, 117 insertions, 0 deletions
diff --git a/doc/html/boost/interprocess/interprocess_condition_any.html b/doc/html/boost/interprocess/interprocess_condition_any.html
new file mode 100644
index 0000000000..52a3c1d231
--- /dev/null
+++ b/doc/html/boost/interprocess/interprocess_condition_any.html
@@ -0,0 +1,117 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Class interprocess_condition_any</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
+<link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_condition_any_hpp" title="Header &lt;boost/interprocess/sync/interprocess_condition_any.hpp&gt;">
+<link rel="prev" href="interprocess_condition.html" title="Class interprocess_condition">
+<link rel="next" href="interprocess_mutex.html" title="Class interprocess_mutex">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center"><a href="../../../../index.html">Home</a></td>
+<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
+<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
+<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
+<td align="center"><a href="../../../../more/index.htm">More</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="interprocess_condition.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_condition_any_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="interprocess_mutex.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="refentry">
+<a name="boost.interprocess.interprocess_condition_any"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2><span class="refentrytitle">Class interprocess_condition_any</span></h2>
+<p>boost::interprocess::interprocess_condition_any</p>
+</div>
+<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
+<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_condition_any_hpp" title="Header &lt;boost/interprocess/sync/interprocess_condition_any.hpp&gt;">boost/interprocess/sync/interprocess_condition_any.hpp</a>&gt;
+
+</span>
+<span class="keyword">class</span> <a class="link" href="interprocess_condition_any.html" title="Class interprocess_condition_any">interprocess_condition_any</a> <span class="special">{</span>
+<span class="keyword">public</span><span class="special">:</span>
+ <span class="comment">// <a class="link" href="interprocess_condition_any.html#boost.interprocess.interprocess_condition_anyconstruct-copy-destruct">construct/copy/destruct</a></span>
+ <a class="link" href="interprocess_condition_any.html#idp66617904-bb"><span class="identifier">interprocess_condition_any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="interprocess_condition_any.html#idp66620000-bb"><span class="special">~</span><span class="identifier">interprocess_condition_any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+
+ <span class="comment">// <a class="link" href="interprocess_condition_any.html#idp66597328-bb">public member functions</a></span>
+ <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp66597888-bb"><span class="identifier">notify_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp66599248-bb"><span class="identifier">notify_all</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> L<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp66600624-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp66604336-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> L<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="interprocess_condition_any.html#idp66608416-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">&gt;</span>
+ <span class="keyword">bool</span> <a class="link" href="interprocess_condition_any.html#idp66612912-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span>
+<span class="special">}</span><span class="special">;</span></pre></div>
+<div class="refsect1">
+<a name="idp248491696"></a><h2>Description</h2>
+<p>This class is a condition variable that can be placed in shared memory or memory mapped files.</p>
+<p>The <a class="link" href="interprocess_condition_any.html" title="Class interprocess_condition_any">interprocess_condition_any</a> class is a generalization of <a class="link" href="interprocess_condition.html" title="Class interprocess_condition">interprocess_condition</a>. Whereas <a class="link" href="interprocess_condition.html" title="Class interprocess_condition">interprocess_condition</a> works only on Locks with mutex_type == <a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a> <a class="link" href="interprocess_condition_any.html" title="Class interprocess_condition_any">interprocess_condition_any</a> can operate on any user-defined lock that meets the BasicLockable requirements (lock()/unlock() member functions).</p>
+<p>Unlike std::condition_variable_any in C++11, it is NOT safe to invoke the destructor if all threads have been only notified. It is required that they have exited their respective wait functions. </p>
+<div class="refsect2">
+<a name="idp248497888"></a><h3>
+<a name="boost.interprocess.interprocess_condition_anyconstruct-copy-destruct"></a><code class="computeroutput">interprocess_condition_any</code>
+ public
+ construct/copy/destruct</h3>
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+<pre class="literallayout"><a name="idp66617904-bb"></a><span class="identifier">interprocess_condition_any</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Constructs a <code class="computeroutput"><a class="link" href="interprocess_condition_any.html" title="Class interprocess_condition_any">interprocess_condition_any</a></code>. On error throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </li>
+<li class="listitem">
+<pre class="literallayout"><a name="idp66620000-bb"></a><span class="special">~</span><span class="identifier">interprocess_condition_any</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<p>Destroys *this liberating system resources. </p>
+</li>
+</ol></div>
+</div>
+<div class="refsect2">
+<a name="idp248511008"></a><h3>
+<a name="idp66597328-bb"></a><code class="computeroutput">interprocess_condition_any</code> public member functions</h3>
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp66597888-bb"></a><span class="identifier">notify_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<p>If there is a thread waiting on *this, change that thread's state to ready. Otherwise there is no effect. </p>
+</li>
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp66599248-bb"></a><span class="identifier">notify_all</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<p>Change the state of all threads waiting on *this to ready. If there are no waiting threads, notify_all() has no effect. </p>
+</li>
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> L<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp66600624-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&amp;</span> lock<span class="special">)</span><span class="special">;</span></pre>
+<p>Releases the lock on the <code class="computeroutput"><a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a></code> object associated with lock, blocks the current thread of execution until readied by a call to this-&gt;notify_one() or this-&gt;notify_all(), and then reacquires the lock. </p>
+</li>
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp66604336-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&amp;</span> lock<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre>
+<p>The same as: while (!pred()) wait(lock) </p>
+</li>
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> L<span class="special">&gt;</span>
+ <span class="keyword">bool</span> <a name="idp66608416-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&amp;</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&amp;</span> abs_time<span class="special">)</span><span class="special">;</span></pre>
+<p>Releases the lock on the <code class="computeroutput"><a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a></code> object associated with lock, blocks the current thread of execution until readied by a call to this-&gt;notify_one() or this-&gt;notify_all(), or until time abs_time is reached, and then reacquires the lock. Returns: false if time abs_time is reached, otherwise true. </p>
+</li>
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">&gt;</span>
+ <span class="keyword">bool</span> <a name="idp66612912-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&amp;</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&amp;</span> abs_time<span class="special">,</span>
+ <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre>
+<p>The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true; </p>
+</li>
+</ol></div>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright &#169; 2005-2012 Ion Gaztanaga<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="interprocess_condition.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_condition_any_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="interprocess_mutex.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>