summaryrefslogtreecommitdiff
path: root/doc/html/boost/interprocess/interprocess_semaphore.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/interprocess/interprocess_semaphore.html')
-rw-r--r--[-rwxr-xr-x]doc/html/boost/interprocess/interprocess_semaphore.html42
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 bcfa8dc870..c5dbdc73fc 100755..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.76.1">
<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_semaphore_hpp" title="Header &lt;boost/interprocess/sync/interprocess_semaphore.hpp&gt;">
-<link rel="prev" href="interprocess_recursive__id997493.html" title="Class interprocess_recursive_mutex">
-<link rel="next" href="interprocess_upgradable_id997866.html" title="Class interprocess_upgradable_mutex">
+<link rel="prev" href="interprocess_rec_id1003782.html" title="Class interprocess_recursive_mutex">
+<link rel="next" href="interprocess_upg_id1004155.html" title="Class interprocess_upgradable_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_recursive__id997493.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_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_upgradable_id997866.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="interprocess_rec_id1003782.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_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_upg_id1004155.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#id997817-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#id997841-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#id1004106-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#id1004130-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#id997677-bb">public member functions</a></span>
- <span class="keyword">void</span> <a class="link" href="interprocess_semaphore.html#id997681-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#id997715-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#id997748-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#id997776-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">&amp;</span><span class="special">)</span><span class="special">;</span>
+ <span class="comment">// <a class="link" href="interprocess_semaphore.html#id1003966-bb">public member functions</a></span>
+ <span class="keyword">void</span> <a class="link" href="interprocess_semaphore.html#id1003969-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#id1004003-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#id1004037-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#id1004064-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">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
-<a name="id1859824"></a><h2>Description</h2>
+<a name="id1877771"></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="id1859841"></a><h3>
+<a name="id1877788"></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="id997817-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="id1004106-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="id997841-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="id1004130-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="id1859975"></a><h3>
-<a name="id997677-bb"></a><code class="computeroutput">interprocess_semaphore</code> public member functions</h3>
+<a name="id1877922"></a><h3>
+<a name="id1003966-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="id997681-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="id1003969-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="id997715-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="id1004003-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="id997748-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="id1004037-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 interprocess_semaphore'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="id997776-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">&amp;</span> abs_time<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">bool</span> <a name="id1004064-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">&amp;</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 interprocess_semaphore'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_recursive__id997493.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_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_upgradable_id997866.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="interprocess_rec_id1003782.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_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_upg_id1004155.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>