diff options
Diffstat (limited to 'doc/html/boost/interprocess/interprocess_semaphore.html')
| -rw-r--r-- | doc/html/boost/interprocess/interprocess_semaphore.html | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/doc/html/boost/interprocess/interprocess_semaphore.html b/doc/html/boost/interprocess/interprocess_semaphore.html index 3c102bfc2f..8bb6092722 100644 --- a/doc/html/boost/interprocess/interprocess_semaphore.html +++ b/doc/html/boost/interprocess/interprocess_semaphore.html @@ -6,8 +6,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_semaphore_hpp" title="Header <boost/interprocess/sync/interprocess_semaphore.hpp>"> -<link rel="prev" href="interprocess_r_idp66640512.html" title="Class interprocess_recursive_mutex"> -<link rel="next" href="interprocess_s_idp66685904.html" title="Class interprocess_sharable_mutex"> +<link rel="prev" href="interprocess_r_idp56590896.html" title="Class interprocess_recursive_mutex"> +<link rel="next" href="interprocess_s_idp56636288.html" title="Class interprocess_sharable_mutex"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -20,7 +20,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_r_idp66640512.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_semaphore_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_s_idp66685904.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interprocess_r_idp56590896.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_semaphore_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_s_idp56636288.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.interprocess_semaphore"></a><div class="titlepage"></div> @@ -35,52 +35,52 @@ <span class="keyword">class</span> <a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="interprocess_semaphore.html#boost.interprocess.interprocess_semaphoreconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="interprocess_semaphore.html#idp66678832-bb"><span class="identifier">interprocess_semaphore</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_semaphore.html#idp66681744-bb"><span class="special">~</span><span class="identifier">interprocess_semaphore</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_semaphore.html#idp56629216-bb"><span class="identifier">interprocess_semaphore</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_semaphore.html#idp56632128-bb"><span class="special">~</span><span class="identifier">interprocess_semaphore</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="interprocess_semaphore.html#idp66662016-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="interprocess_semaphore.html#idp66662576-bb"><span class="identifier">post</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_semaphore.html#idp66666224-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_semaphore.html#idp66669856-bb"><span class="identifier">try_wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_semaphore.html#idp66673488-bb"><span class="identifier">timed_wait</span></a><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_semaphore.html#idp56612400-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="interprocess_semaphore.html#idp56612960-bb"><span class="identifier">post</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_semaphore.html#idp56616608-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_semaphore.html#idp56620240-bb"><span class="identifier">try_wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_semaphore.html#idp56623872-bb"><span class="identifier">timed_wait</span></a><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="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp248811088"></a><h2>Description</h2> +<a name="idp242101712"></a><h2>Description</h2> <p>Wraps a <a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a> that can be placed in shared memory and can be shared between processes. Allows timed lock tries </p> <div class="refsect2"> -<a name="idp248812832"></a><h3> +<a name="idp242103456"></a><h3> <a name="boost.interprocess.interprocess_semaphoreconstruct-copy-destruct"></a><code class="computeroutput">interprocess_semaphore</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp66678832-bb"></a><span class="identifier">interprocess_semaphore</span><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">int</span> initialCount<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56629216-bb"></a><span class="identifier">interprocess_semaphore</span><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">int</span> initialCount<span class="special">)</span><span class="special">;</span></pre> <p>Creates a <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> with the given initial count. <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if there is an error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp66681744-bb"></a><span class="special">~</span><span class="identifier">interprocess_semaphore</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56632128-bb"></a><span class="special">~</span><span class="identifier">interprocess_semaphore</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code>. Does not throw </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp248828816"></a><h3> -<a name="idp66662016-bb"></a><code class="computeroutput">interprocess_semaphore</code> public member functions</h3> +<a name="idp242119248"></a><h3> +<a name="idp56612400-bb"></a><code class="computeroutput">interprocess_semaphore</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="idp66662576-bb"></a><span class="identifier">post</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56612960-bb"></a><span class="identifier">post</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Increments the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> count. If there are processes/threads blocked waiting for the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code>, then one of these processes will return successfully from its wait function. If there is an error an <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> exception is thrown. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp66666224-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56616608-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Decrements the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code>. If the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> value is not greater than zero, then the calling process/thread blocks until it can decrement the counter. If there is an error an <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> exception is thrown. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp66669856-bb"></a><span class="identifier">try_wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56620240-bb"></a><span class="identifier">try_wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Decrements the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> if the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code>'s value is greater than zero and returns true. If the value is not greater than zero returns false. If there is an error an <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> exception is thrown. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp66673488-bb"></a><span class="identifier">timed_wait</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> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56623872-bb"></a><span class="identifier">timed_wait</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> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Decrements the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> if the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code>'s value is greater than zero and returns true. Otherwise, waits for the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> to the posted or the timeout expires. If the timeout expires, the function returns false. If the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> is posted the function returns true. If there is an error throws sem_exception </p> </li> </ol></div> @@ -97,7 +97,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_r_idp66640512.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_semaphore_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_s_idp66685904.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interprocess_r_idp56590896.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_semaphore_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_s_idp56636288.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |