<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class interprocess_condition</title>
<link rel="stylesheet" href="../../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/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.sync.interprocess_condition_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="interprocess_mutex.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class interprocess_condition">
<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="emphasis"><em>// 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>>
</em></span>
<span class="bold"><strong>class</strong></span> <a class="link" href="interprocess_condition.html" title="Class interprocess_condition">interprocess_condition</a> {
<span class="bold"><strong>public</strong></span>:
<span class="emphasis"><em>// <a class="link" href="interprocess_condition.html#boost.interprocess.interprocess_conditionconstruct-copy-destruct">construct/copy/destruct</a></em></span>
<a class="link" href="interprocess_condition.html#id821510-bb">interprocess_condition</a>();
<a class="link" href="interprocess_condition.html#id821516-bb">~interprocess_condition</a>();
<span class="emphasis"><em>// <a class="link" href="interprocess_condition.html#id821072-bb">public member functions</a></em></span>
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="interprocess_condition.html#id821076-bb">notify_one</a>() ;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="interprocess_condition.html#id821088-bb">notify_all</a>() ;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> L> <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="interprocess_condition.html#id821101-bb">wait</a>(L &) ;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> L, <span class="bold"><strong>typename</strong></span> Pr> <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="interprocess_condition.html#id821400-bb">wait</a>(L &, Pr) ;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> L> <span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="interprocess_condition.html#id821434-bb">timed_wait</a>(L &, <span class="bold"><strong>const</strong></span> boost::posix_time::ptime &) ;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> L, <span class="bold"><strong>typename</strong></span> Pr>
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="interprocess_condition.html#id821469-bb">timed_wait</a>(L &, <span class="bold"><strong>const</strong></span> boost::posix_time::ptime &, Pr) ;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id1056341"></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" title="interprocess_condition public construct/copy/destruct">
<a name="id1056348"></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="id821510-bb"></a>interprocess_condition();</pre>
<p>Constructs a interprocess_condition. On error throws interprocess_exception. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="id821516-bb"></a>~interprocess_condition();</pre>
<p>Destroys *this liberating system resources. </p>
</li>
</ol></div>
</div>
<div class="refsect2" title="interprocess_condition public member functions">
<a name="id1056402"></a><h3>
<a name="id821072-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="type"><span class="bold"><strong>void</strong></span></span> <a name="id821076-bb"></a>notify_one() ;</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="type"><span class="bold"><strong>void</strong></span></span> <a name="id821088-bb"></a>notify_all() ;</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="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> L> <span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id821101-bb"></a>wait(L & lock) ;</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="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> L, <span class="bold"><strong>typename</strong></span> Pr> <span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id821400-bb"></a>wait(L & lock, Pr pred) ;</pre>
<p>The same as: while (!pred()) wait(lock) </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> L>
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id821434-bb"></a>timed_wait(L & lock, <span class="bold"><strong>const</strong></span> boost::posix_time::ptime & abs_time) ;</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="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> L, <span class="bold"><strong>typename</strong></span> Pr>
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id821469-bb"></a>timed_wait(L & lock, <span class="bold"><strong>const</strong></span> boost::posix_time::ptime & abs_time,
Pr pred) ;</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/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.sync.interprocess_condition_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="interprocess_mutex.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
