summaryrefslogtreecommitdiff
path: root/doc/html/boost/interprocess/interprocess_mutex.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/interprocess/interprocess_mutex.html')
-rw-r--r--doc/html/boost/interprocess/interprocess_mutex.html40
1 files changed, 20 insertions, 20 deletions
diff --git a/doc/html/boost/interprocess/interprocess_mutex.html b/doc/html/boost/interprocess/interprocess_mutex.html
index 09b21b7564..2c8969069a 100644
--- a/doc/html/boost/interprocess/interprocess_mutex.html
+++ b/doc/html/boost/interprocess/interprocess_mutex.html
@@ -8,7 +8,7 @@
<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_mutex_hpp" title="Header &lt;boost/interprocess/sync/interprocess_mutex.hpp&gt;">
<link rel="prev" href="interprocess_condition_any.html" title="Class interprocess_condition_any">
-<link rel="next" href="interprocess_r_idp48028896.html" title="Class interprocess_recursive_mutex">
+<link rel="next" href="interprocess_r_idp45215584.html" title="Class interprocess_recursive_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_condition_any.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_mutex_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_r_idp48028896.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="interprocess_condition_any.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_mutex_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_r_idp45215584.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.interprocess.interprocess_mutex"></a><div class="titlepage"></div>
@@ -36,52 +36,52 @@
<span class="keyword">class</span> <a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// <a class="link" href="interprocess_mutex.html#boost.interprocess.interprocess_mutexconstruct-copy-destruct">construct/copy/destruct</a></span>
- <a class="link" href="interprocess_mutex.html#idp48023888-bb"><span class="identifier">interprocess_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <a class="link" href="interprocess_mutex.html#idp48025344-bb"><span class="special">~</span><span class="identifier">interprocess_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="interprocess_mutex.html#idp45210576-bb"><span class="identifier">interprocess_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="interprocess_mutex.html#idp45212032-bb"><span class="special">~</span><span class="identifier">interprocess_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="comment">// <a class="link" href="interprocess_mutex.html#idp48013488-bb">public member functions</a></span>
- <span class="keyword">void</span> <a class="link" href="interprocess_mutex.html#idp48014048-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="keyword">bool</span> <a class="link" href="interprocess_mutex.html#idp48016304-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="keyword">bool</span> <a class="link" href="interprocess_mutex.html#idp48018592-bb"><span class="identifier">timed_lock</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="keyword">void</span> <a class="link" href="interprocess_mutex.html#idp48021648-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="comment">// <a class="link" href="interprocess_mutex.html#idp45200176-bb">public member functions</a></span>
+ <span class="keyword">void</span> <a class="link" href="interprocess_mutex.html#idp45200736-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">bool</span> <a class="link" href="interprocess_mutex.html#idp45202992-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">bool</span> <a class="link" href="interprocess_mutex.html#idp45205280-bb"><span class="identifier">timed_lock</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="keyword">void</span> <a class="link" href="interprocess_mutex.html#idp45208336-bb"><span class="identifier">unlock</span></a><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="idp384589472"></a><h2>Description</h2>
+<a name="idp289170352"></a><h2>Description</h2>
<p>Wraps a <a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a> that can be placed in shared memory and can be shared between processes. Allows timed lock tries </p>
<div class="refsect2">
-<a name="idp384591168"></a><h3>
+<a name="idp289172048"></a><h3>
<a name="boost.interprocess.interprocess_mutexconstruct-copy-destruct"></a><code class="computeroutput">interprocess_mutex</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
-<pre class="literallayout"><a name="idp48023888-bb"></a><span class="identifier">interprocess_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idp45210576-bb"></a><span class="identifier">interprocess_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructor. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><a name="idp48025344-bb"></a><span class="special">~</span><span class="identifier">interprocess_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idp45212032-bb"></a><span class="special">~</span><span class="identifier">interprocess_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Destructor. If any process uses the mutex after the destructor is called the result is undefined. Does not throw. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
-<a name="idp384603152"></a><h3>
-<a name="idp48013488-bb"></a><code class="computeroutput">interprocess_mutex</code> public member functions</h3>
+<a name="idp289183968"></a><h3>
+<a name="idp45200176-bb"></a><code class="computeroutput">interprocess_mutex</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="idp48014048-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp45200736-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Effects: The calling thread tries to obtain ownership of the mutex, and if another thread has ownership of the mutex, it waits until it can obtain the ownership. If a thread takes ownership of the mutex the mutex must be unlocked by the same mutex. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">bool</span> <a name="idp48016304-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">bool</span> <a name="idp45202992-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Effects: The calling thread tries to obtain ownership of the mutex, and if another thread has ownership of the mutex returns immediately. Returns: If the thread acquires ownership of the mutex, returns true, if the another thread has ownership of the mutex, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">bool</span> <a name="idp48018592-bb"></a><span class="identifier">timed_lock</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="idp45205280-bb"></a><span class="identifier">timed_lock</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>Effects: The calling thread will try to obtain exclusive ownership of the mutex if it can do so in until the specified time is reached. If the mutex supports recursive locking, the mutex must be unlocked the same number of times it is locked. Returns: If the thread acquires ownership of the mutex, returns true, if the timeout expires returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idp48021648-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp45208336-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Effects: The calling thread releases the exclusive ownership of the mutex. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p>
</li>
</ol></div>
@@ -98,7 +98,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="interprocess_condition_any.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_mutex_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_r_idp48028896.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="interprocess_condition_any.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_mutex_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_r_idp45215584.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>