doc/html/boost/interprocess/interprocess_condition.html

   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=US-ASCII">
   5 <title>Class interprocess_condition</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_hpp" title="Header &lt;boost/interprocess/sync/interprocess_condition.hpp&gt;">
  10 <link rel="prev" href="file_lock.html" title="Class file_lock">
  11 <link rel="next" href="interprocess_condition_any.html" title="Class interprocess_condition_any">
  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="file_lock.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_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_condition_any.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.interprocess.interprocess_condition"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class interprocess_condition</span></h2>
  30 <p>boost::interprocess::interprocess_condition</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: &lt;<a class="link" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_condition_hpp" title="Header &lt;boost/interprocess/sync/interprocess_condition.hpp&gt;">boost/interprocess/sync/interprocess_condition.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">class</span> <a class="link" href="interprocess_condition.html" title="Class interprocess_condition">interprocess_condition</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.html#boost.interprocess.interprocess_conditionconstruct-copy-destruct">construct/copy/destruct</a></span>
  39   <a class="link" href="interprocess_condition.html#idm45336640636704-bb"><span class="identifier">interprocess_condition</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  40   <a class="link" href="interprocess_condition.html#idm45336640634624-bb"><span class="special">~</span><span class="identifier">interprocess_condition</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.html#idm45336640657280-bb">public member functions</a></span>
  43   <span class="keyword">void</span> <a class="link" href="interprocess_condition.html#idm45336640656720-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.html#idm45336640655360-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">&lt;</span><span class="keyword">typename</span> L<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="interprocess_condition.html#idm45336640653984-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>
  46   <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.html#idm45336640650272-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>
  47   <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.html#idm45336640646192-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>
  48   <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>
  49     <span class="keyword">bool</span> <a class="link" href="interprocess_condition.html#idm45336640641696-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>
  50 <span class="special">}</span><span class="special">;</span></pre></div>
  51 <div class="refsect1">
  52 <a name="id-1.3.19.17.3.58.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. Destroys the object of type std::condition_variable_any</p>
  54 <p>Unlike std::condition_variable 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>
  55 <div class="refsect2">
  56 <a name="id-1.3.19.17.3.58.4.4.4"></a><h3>
  57 <a name="boost.interprocess.interprocess_conditionconstruct-copy-destruct"></a><code class="computeroutput">interprocess_condition</code>
  58         public
  59        construct/copy/destruct</h3>
  60 <div class="orderedlist"><ol class="orderedlist" type="1">
  61 <li class="listitem">
  62 <pre class="literallayout"><a name="idm45336640636704-bb"></a><span class="identifier">interprocess_condition</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.html" title="Class interprocess_condition">interprocess_condition</a></code>. On error throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </li>
  63 <li class="listitem">
  64 <pre class="literallayout"><a name="idm45336640634624-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>
  65 <p>Destroys *this liberating system resources. </p>
  66 </li>
  67 </ol></div>
  68 </div>
  69 <div class="refsect2">
  70 <a name="id-1.3.19.17.3.58.4.4.5"></a><h3>
  71 <a name="idm45336640657280-bb"></a><code class="computeroutput">interprocess_condition</code> public member functions</h3>
  72 <div class="orderedlist"><ol class="orderedlist" type="1">
  73 <li class="listitem">
  74 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336640656720-bb"></a><span class="identifier">notify_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  75 <p>If there is a thread waiting on *this, change that thread's state to ready. Otherwise there is no effect. </p>
  76 </li>
  77 <li class="listitem">
  78 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336640655360-bb"></a><span class="identifier">notify_all</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  79 <p>Change the state of all threads waiting on *this to ready. If there are no waiting threads, notify_all() has no effect. </p>
  80 </li>
  81 <li class="listitem">
  82 <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="idm45336640653984-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>
  83 <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>
  84 </li>
  85 <li class="listitem">
  86 <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="idm45336640650272-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>
  87 <p>The same as: while (!pred()) wait(lock) </p>
  88 </li>
  89 <li class="listitem">
  90 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> L<span class="special">&gt;</span>
  91   <span class="keyword">bool</span> <a name="idm45336640646192-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>
  92 <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>
  93 </li>
  94 <li class="listitem">
  95 <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>
  96   <span class="keyword">bool</span> <a name="idm45336640641696-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>
  97                   <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre>
  98 <p>The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true; </p>
  99 </li>
 100 </ol></div>
 101 </div>
 102 </div>
 103 </div>
 104 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 105 <td align="left"></td>
 106 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2015 Ion Gaztanaga<p>
 107         Distributed under the Boost Software License, Version 1.0. (See accompanying
 108         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>)
 109       </p>
 110 </div></td>
 111 </tr></table>
 112 <hr>
 113 <div class="spirit-nav">
 114 <a accesskey="p" href="file_lock.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_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_condition_any.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 115 </div>
 116 </body>
 117 </html>