1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Class interprocess_condition_any</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_condition_any_hpp" title="Header <boost/interprocess/sync/interprocess_condition_any.hpp>"> 10<link rel="prev" href="interprocess_condition.html" title="Class interprocess_condition"> 11<link rel="next" href="interprocess_mutex.html" title="Class interprocess_mutex"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<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> 25</div> 26<div class="refentry"> 27<a name="boost.interprocess.interprocess_condition_any"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class interprocess_condition_any</span></h2> 30<p>boost::interprocess::interprocess_condition_any</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"><span class="comment">// In header: <<a class="link" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_condition_any_hpp" title="Header <boost/interprocess/sync/interprocess_condition_any.hpp>">boost/interprocess/sync/interprocess_condition_any.hpp</a>> 34 35</span> 36<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> 37<span class="keyword">public</span><span class="special">:</span> 38 <span class="comment">// <a class="link" href="interprocess_condition_any.html#boost.interprocess.interprocess_condition_anyconstruct-copy-destruct">construct/copy/destruct</a></span> 39 <a class="link" href="interprocess_condition_any.html#idm45304010383808-bb"><span class="identifier">interprocess_condition_any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 40 <a class="link" href="interprocess_condition_any.html#idm45304010381712-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> 41 42 <span class="comment">// <a class="link" href="interprocess_condition_any.html#idm45304010404384-bb">public member functions</a></span> 43 <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idm45304010403824-bb"><span class="identifier">notify_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 44 <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idm45304010402464-bb"><span class="identifier">notify_all</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 45 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idm45304010401088-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 46 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idm45304010397376-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> 47 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="interprocess_condition_any.html#idm45304010393296-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</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">&</span><span class="special">)</span><span class="special">;</span> 48 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> 49 <span class="keyword">bool</span> <a class="link" href="interprocess_condition_any.html#idm45304010388800-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</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">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> 50<span class="special">}</span><span class="special">;</span></pre></div> 51<div class="refsect1"> 52<a name="id-1.3.19.17.3.59.4.4"></a><h2>Description</h2> 53<p>This class is a condition variable that can be placed in shared memory or memory mapped files.</p> 54<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> 55<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> 56<div class="refsect2"> 57<a name="id-1.3.19.17.3.59.4.4.5"></a><h3> 58<a name="boost.interprocess.interprocess_condition_anyconstruct-copy-destruct"></a><code class="computeroutput">interprocess_condition_any</code> 59 public 60 construct/copy/destruct</h3> 61<div class="orderedlist"><ol class="orderedlist" type="1"> 62<li class="listitem"> 63<pre class="literallayout"><a name="idm45304010383808-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> 64<li class="listitem"> 65<pre class="literallayout"><a name="idm45304010381712-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> 66<p>Destroys *this liberating system resources. </p> 67</li> 68</ol></div> 69</div> 70<div class="refsect2"> 71<a name="id-1.3.19.17.3.59.4.4.6"></a><h3> 72<a name="idm45304010404384-bb"></a><code class="computeroutput">interprocess_condition_any</code> public member functions</h3> 73<div class="orderedlist"><ol class="orderedlist" type="1"> 74<li class="listitem"> 75<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304010403824-bb"></a><span class="identifier">notify_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 76<p>If there is a thread waiting on *this, change that thread's state to ready. Otherwise there is no effect. </p> 77</li> 78<li class="listitem"> 79<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304010402464-bb"></a><span class="identifier">notify_all</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 80<p>Change the state of all threads waiting on *this to ready. If there are no waiting threads, notify_all() has no effect. </p> 81</li> 82<li class="listitem"> 83<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">void</span> <a name="idm45304010401088-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">)</span><span class="special">;</span></pre> 84<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->notify_one() or this->notify_all(), and then reacquires the lock. </p> 85</li> 86<li class="listitem"> 87<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a name="idm45304010397376-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> 88<p>The same as: while (!pred()) wait(lock) </p> 89</li> 90<li class="listitem"> 91<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> 92 <span class="keyword">bool</span> <a name="idm45304010393296-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</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">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> 93<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->notify_one() or this->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> 94</li> 95<li class="listitem"> 96<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> 97 <span class="keyword">bool</span> <a name="idm45304010388800-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</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">&</span> abs_time<span class="special">,</span> 98 <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> 99<p>The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true; </p> 100</li> 101</ol></div> 102</div> 103</div> 104</div> 105<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 106<td align="left"></td> 107<td align="right"><div class="copyright-footer">Copyright © 2005-2015 Ion Gaztanaga<p> 108 Distributed under the Boost Software License, Version 1.0. (See accompanying 109 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>) 110 </p> 111</div></td> 112</tr></table> 113<hr> 114<div class="spirit-nav"> 115<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> 116</div> 117</body> 118</html> 119
