diff options
Diffstat (limited to 'doc/html/boost/interprocess/interprocess_condition_any.html')
| -rw-r--r-- | doc/html/boost/interprocess/interprocess_condition_any.html | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/doc/html/boost/interprocess/interprocess_condition_any.html b/doc/html/boost/interprocess/interprocess_condition_any.html index 6f3165c06d..bf2fd52a85 100644 --- a/doc/html/boost/interprocess/interprocess_condition_any.html +++ b/doc/html/boost/interprocess/interprocess_condition_any.html @@ -36,17 +36,17 @@ <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#idp56770960-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#idp56773056-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#idp40874256-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#idp40876352-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#idp56750384-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp56750944-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#idp56752304-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#idp56753680-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#idp56757392-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#idp56761472-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#idp40853680-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp40854240-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#idp40855600-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#idp40856976-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#idp40860688-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#idp40864768-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#idp56765968-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#idp40869264-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="id-1.3.18.17.3.59.4.4"></a><h2>Description</h2> @@ -60,41 +60,41 @@ construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp56770960-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="idp40874256-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="idp56773056-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="idp40876352-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="id-1.3.18.17.3.59.4.4.6"></a><h3> -<a name="idp56750384-bb"></a><code class="computeroutput">interprocess_condition_any</code> public member functions</h3> +<a name="idp40853680-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="idp56750944-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="idp40854240-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="idp56752304-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="idp40855600-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="idp56753680-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="idp40856976-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="idp56757392-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="idp40860688-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="idp56761472-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="idp40864768-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="idp56765968-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="idp40869264-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> |