<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class interprocess_condition</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../boost_interprocess_reference.html#header.boost.interprocess.sync.interprocess_condition_hpp" title="Header <boost/interprocess/sync/interprocess_condition.hpp>"> <link rel="prev" href="barrier.html" title="Class barrier"> <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="barrier.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.sync.interprocess_condition_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"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class interprocess_condition</span></h2> <p>boost::interprocess::interprocess_condition</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: <<a class="link" href="../../boost_interprocess_reference.html#header.boost.interprocess.sync.interprocess_condition_hpp" title="Header <boost/interprocess/sync/interprocess_condition.hpp>">boost/interprocess/sync/interprocess_condition.hpp</a>> </span> <span class="keyword">class</span> <a class="link" href="interprocess_condition.html" title="Class interprocess_condition">interprocess_condition</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="interprocess_condition.html#boost.interprocess.interprocess_conditionconstruct-copy-destruct">construct/copy/destruct</a></span> <a class="link" href="interprocess_condition.html#id829576-bb"><span class="identifier">interprocess_condition</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <a class="link" href="interprocess_condition.html#id829581-bb"><span class="special">~</span><span class="identifier">interprocess_condition</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="comment">// <a class="link" href="interprocess_condition.html#id829409-bb">public member functions</a></span> <span class="keyword">void</span> <a class="link" href="interprocess_condition.html#id829412-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.html#id829425-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"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">void</span> <a class="link" href="interprocess_condition.html#id829438-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> <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.html#id829465-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> <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.html#id829500-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> <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">bool</span> <a class="link" href="interprocess_condition.html#id829534-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> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> <a name="id1535777"></a><h2>Description</h2> <p>This class is a condition variable that can be placed in shared memory or memory mapped files. </p> <div class="refsect2"> <a name="id1535785"></a><h3> <a name="boost.interprocess.interprocess_conditionconstruct-copy-destruct"></a><code class="computeroutput">interprocess_condition</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><a name="id829576-bb"></a><span class="identifier">interprocess_condition</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs a interprocess_condition. On error throws interprocess_exception. </p> </li> <li class="listitem"> <pre class="literallayout"><a name="id829581-bb"></a><span class="special">~</span><span class="identifier">interprocess_condition</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="id1535875"></a><h3> <a name="id829409-bb"></a><code class="computeroutput">interprocess_condition</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="id829412-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="id829425-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"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">void</span> <a name="id829438-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> <p>Releases the lock on the interprocess_mutex 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> </li> <li class="listitem"> <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="id829465-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> <p>The same as: while (!pred()) wait(lock) </p> </li> <li class="listitem"> <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">bool</span> <a name="id829500-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> <p>Releases the lock on the interprocess_mutex 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> </li> <li class="listitem"> <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">bool</span> <a name="id829534-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="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 © 2005 - 2008 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="barrier.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.sync.interprocess_condition_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>