diff options
| author | DongHun Kwak <dh0128.kwak@samsung.com> | 2016-10-06 10:41:18 +0900 |
|---|---|---|
| committer | DongHun Kwak <dh0128.kwak@samsung.com> | 2016-10-06 10:43:11 +0900 |
| commit | f763a99a501650eff2c60288aa6f10ef916d769e (patch) | |
| tree | 02af7e13f9a38c888ebf340fe764cbe7dae99da9 /doc/html/boost/interprocess/interprocess_semaphore.html | |
| parent | 5cde13f21d36c7224b0e13d11c4b49379ae5210d (diff) | |
| download | boost-f763a99a501650eff2c60288aa6f10ef916d769e.tar.gz boost-f763a99a501650eff2c60288aa6f10ef916d769e.tar.bz2 boost-f763a99a501650eff2c60288aa6f10ef916d769e.zip | |
Imported Upstream version 1.62.0upstream/1.62.0
Change-Id: I9d4c1ddb7b7d8f0069217ecc582700f9fda6dd4c
Signed-off-by: DongHun Kwak <dh0128.kwak@samsung.com>
Diffstat (limited to 'doc/html/boost/interprocess/interprocess_semaphore.html')
| -rw-r--r-- | doc/html/boost/interprocess/interprocess_semaphore.html | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/doc/html/boost/interprocess/interprocess_semaphore.html b/doc/html/boost/interprocess/interprocess_semaphore.html index 87c6413c7a..40f5c7d5a7 100644 --- a/doc/html/boost/interprocess/interprocess_semaphore.html +++ b/doc/html/boost/interprocess/interprocess_semaphore.html @@ -4,11 +4,11 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class interprocess_semaphore</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.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_idp24316352.html" title="Class interprocess_recursive_mutex"> -<link rel="next" href="interprocess_s_idp24361744.html" title="Class interprocess_sharable_mutex"> +<link rel="prev" href="interpro_idm46037321947808.html" title="Class interprocess_recursive_mutex"> +<link rel="next" href="interpro_idm46037321902416.html" title="Class interprocess_sharable_mutex"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_r_idp24316352.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_idp24361744.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interpro_idm46037321947808.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="interpro_idm46037321902416.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> @@ -36,52 +36,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#idp24354672-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#idp24357584-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#idm46037321909488-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#idm46037321906576-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#idp24337856-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="interprocess_semaphore.html#idp24338416-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#idp24342064-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#idp24345696-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#idp24349328-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#idm46037321926304-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="interprocess_semaphore.html#idm46037321925744-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#idm46037321922096-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#idm46037321918464-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#idm46037321914832-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="idp177045024"></a><h2>Description</h2> +<a name="idm45928008808352"></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="idp177046768"></a><h3> +<a name="idm45928008806608"></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="idp24354672-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="idm46037321909488-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="idp24357584-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="idm46037321906576-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="idp177062688"></a><h3> -<a name="idp24337856-bb"></a><code class="computeroutput">interprocess_semaphore</code> public member functions</h3> +<a name="idm45928008790736"></a><h3> +<a name="idm46037321926304-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="idp24338416-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="idm46037321925744-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="idp24342064-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="idm46037321922096-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="idp24345696-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="idm46037321918464-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="idp24349328-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="idm46037321914832-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> @@ -98,7 +98,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_r_idp24316352.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_idp24361744.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interpro_idm46037321947808.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="interpro_idm46037321902416.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |