summaryrefslogtreecommitdiff
path: root/doc/html/boost/interprocess/file_lock.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/interprocess/file_lock.html')
-rw-r--r--doc/html/boost/interprocess/file_lock.html66
1 files changed, 33 insertions, 33 deletions
diff --git a/doc/html/boost/interprocess/file_lock.html b/doc/html/boost/interprocess/file_lock.html
index fc82a5f111..bd1258a3d8 100644
--- a/doc/html/boost/interprocess/file_lock.html
+++ b/doc/html/boost/interprocess/file_lock.html
@@ -36,90 +36,90 @@
<span class="keyword">class</span> <a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// <a class="link" href="file_lock.html#boost.interprocess.file_lockconstruct-copy-destruct">construct/copy/destruct</a></span>
- <a class="link" href="file_lock.html#idm46037322034544-bb"><span class="identifier">file_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <a class="link" href="file_lock.html#idm46037322033808-bb"><span class="identifier">file_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
- <a class="link" href="file_lock.html#idm46037322031584-bb"><span class="identifier">file_lock</span></a><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
- <a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;</span> <a class="link" href="file_lock.html#idm46037322029776-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
- <a class="link" href="file_lock.html#idm46037322027408-bb"><span class="special">~</span><span class="identifier">file_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="file_lock.html#idp56817856-bb"><span class="identifier">file_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="file_lock.html#idp56818592-bb"><span class="identifier">file_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="file_lock.html#idp56820816-bb"><span class="identifier">file_lock</span></a><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;</span> <a class="link" href="file_lock.html#idp56822624-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="file_lock.html#idp56824992-bb"><span class="special">~</span><span class="identifier">file_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="comment">// <a class="link" href="file_lock.html#idm46037322056800-bb">public member functions</a></span>
- <span class="keyword">void</span> <a class="link" href="file_lock.html#idm46037322056240-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
- <span class="keyword">void</span> <a class="link" href="file_lock.html#idm46037322053984-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="file_lock.html#idm46037322051776-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="file_lock.html#idm46037322049488-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="file_lock.html#idm46037322046496-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="keyword">void</span> <a class="link" href="file_lock.html#idm46037322044320-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="keyword">bool</span> <a class="link" href="file_lock.html#idm46037322042128-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="keyword">bool</span> <a class="link" href="file_lock.html#idm46037322039856-bb"><span class="identifier">timed_lock_sharable</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="file_lock.html#idm46037322036880-bb"><span class="identifier">unlock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="comment">// <a class="link" href="file_lock.html#idp56795600-bb">public member functions</a></span>
+ <span class="keyword">void</span> <a class="link" href="file_lock.html#idp56796160-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">void</span> <a class="link" href="file_lock.html#idp56798416-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="file_lock.html#idp56800624-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="file_lock.html#idp56802912-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="file_lock.html#idp56805904-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">void</span> <a class="link" href="file_lock.html#idp56808080-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">bool</span> <a class="link" href="file_lock.html#idp56810272-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">bool</span> <a class="link" href="file_lock.html#idp56812544-bb"><span class="identifier">timed_lock_sharable</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="file_lock.html#idp56815520-bb"><span class="identifier">unlock_sharable</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="idm45928009463328"></a><h2>Description</h2>
+<a name="idp283393456"></a><h2>Description</h2>
<p>A file lock, is a mutual exclusion utility similar to a mutex using a file. A file lock has sharable and exclusive locking capabilities and can be used with <a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> and <a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a> classes. A file lock can't guarantee synchronization between threads of the same process so just use file locks to synchronize threads from different processes. </p>
<div class="refsect2">
-<a name="idm45928009460560"></a><h3>
+<a name="idp283396224"></a><h3>
<a name="boost.interprocess.file_lockconstruct-copy-destruct"></a><code class="computeroutput">file_lock</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
-<pre class="literallayout"><a name="idm46037322034544-bb"></a><span class="identifier">file_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idp56817856-bb"></a><span class="identifier">file_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructs an empty file mapping. Does not throw </p>
</li>
<li class="listitem">
-<pre class="literallayout"><a name="idm46037322033808-bb"></a><span class="identifier">file_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idp56818592-bb"></a><span class="identifier">file_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre>
<p>Opens a file lock. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if the file does not exist or there are no operating system resources. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><a name="idm46037322031584-bb"></a><span class="identifier">file_lock</span><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;&amp;</span> moved<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idp56820816-bb"></a><span class="identifier">file_lock</span><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;&amp;</span> moved<span class="special">)</span><span class="special">;</span></pre>
<p>Moves the ownership of "moved"'s file mapping object to *this. After the call, "moved" does not represent any file mapping object. Does not throw </p>
</li>
<li class="listitem">
-<pre class="literallayout"><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;</span> <a name="idm46037322029776-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;&amp;</span> moved<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;</span> <a name="idp56822624-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;&amp;</span> moved<span class="special">)</span><span class="special">;</span></pre>
<p>Moves the ownership of "moved"'s file mapping to *this. After the call, "moved" does not represent any file mapping. Does not throw </p>
</li>
<li class="listitem">
-<pre class="literallayout"><a name="idm46037322027408-bb"></a><span class="special">~</span><span class="identifier">file_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Closes a file lock. Does not throw. </li>
+<pre class="literallayout"><a name="idp56824992-bb"></a><span class="special">~</span><span class="identifier">file_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Closes a file lock. Does not throw. </li>
</ol></div>
</div>
<div class="refsect2">
-<a name="idm45928009429616"></a><h3>
-<a name="idm46037322056800-bb"></a><code class="computeroutput">file_lock</code> public member functions</h3>
+<a name="idp283427120"></a><h3>
+<a name="idp56795600-bb"></a><code class="computeroutput">file_lock</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="idm46037322056240-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp56796160-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
<p>Swaps two file_locks. Does not throw. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idm46037322053984-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="idp56798416-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 exclusive ownership of the mutex, and if another thread has exclusive, or sharable ownership of the mutex, it waits until it can obtain the ownership. 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="idm46037322051776-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="idp56800624-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 acquire exclusive ownership of the mutex without waiting. If no other thread has exclusive, or sharable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, 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="idm46037322049488-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="idp56802912-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 tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, or sharable ownership of the mutex or abs_time is reached. Returns: If acquires exclusive ownership, returns true. Otherwise 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="idm46037322046496-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="idp56805904-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Precondition: The thread must have exclusive ownership of the mutex. Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from <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="idm46037322044320-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp56808080-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. 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="idm46037322042128-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56810272-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, 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="idm46037322039856-bb"></a><span class="identifier">timed_lock_sharable</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="idp56812544-bb"></a><span class="identifier">timed_lock_sharable</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 tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. Returns: If acquires sharable ownership, returns true. Otherwise 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="idm46037322036880-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp56815520-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Precondition: The thread must have sharable ownership of the mutex. Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p>
</li>
</ol></div>