diff options
Diffstat (limited to 'doc/html/boost/interprocess/interprocess_condition_any.html')
-rw-r--r-- | doc/html/boost/interprocess/interprocess_condition_any.html | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/doc/html/boost/interprocess/interprocess_condition_any.html b/doc/html/boost/interprocess/interprocess_condition_any.html index 0e3226323a..292424c26f 100644 --- a/doc/html/boost/interprocess/interprocess_condition_any.html +++ b/doc/html/boost/interprocess/interprocess_condition_any.html @@ -36,65 +36,65 @@ <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#idp45192976-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#idp45195072-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> + <a class="link" href="interprocess_condition_any.html#idp63997392-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#idp63999488-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#idp45172400-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp45172960-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#idp45174320-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_any.html#idp45175696-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_any.html#idp45179408-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_any.html#idp45183488-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="comment">// <a class="link" href="interprocess_condition_any.html#idp63976816-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp63977376-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#idp63978736-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_any.html#idp63980112-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_any.html#idp63983824-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_any.html#idp63987904-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_any.html#idp45187984-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="keyword">bool</span> <a class="link" href="interprocess_condition_any.html#idp63992400-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="idp289040544"></a><h2>Description</h2> +<a name="idp264877760"></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="idp289046736"></a><h3> +<a name="idp264883952"></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="idp45192976-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> +<pre class="literallayout"><a name="idp63997392-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="idp45195072-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> +<pre class="literallayout"><a name="idp63999488-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="idp289059840"></a><h3> -<a name="idp45172400-bb"></a><code class="computeroutput">interprocess_condition_any</code> public member functions</h3> +<a name="idp264897072"></a><h3> +<a name="idp63976816-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="idp45172960-bb"></a><span class="identifier">notify_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp63977376-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="idp45174320-bb"></a><span class="identifier">notify_all</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp63978736-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="idp45175696-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> +<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="idp63980112-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 <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> </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="idp45179408-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> +<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="idp63983824-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="idp45183488-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> + <span class="keyword">bool</span> <a name="idp63987904-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 <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> </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="idp45187984-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="keyword">bool</span> <a name="idp63992400-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> |