doc/html/boost/interprocess/null_mutex.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class null_mutex</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.null_mutex_hpp" title="Header &lt;boost/interprocess/sync/null_mutex.hpp&gt;">
   9 <link rel="prev" href="named_upgradable_mutex.html" title="Class named_upgradable_mutex">
  10 <link rel="next" href="scoped_lock.html" title="Class template scoped_lock">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="named_upgradable_mutex.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.null_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="scoped_lock.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.interprocess.null_mutex"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class null_mutex</span></h2>
  29 <p>boost::interprocess::null_mutex</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.null_mutex_hpp" title="Header &lt;boost/interprocess/sync/null_mutex.hpp&gt;">boost/interprocess/sync/null_mutex.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="null_mutex.html" title="Class null_mutex">null_mutex</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="null_mutex.html#boost.interprocess.null_mutexconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="null_mutex.html#idp67136736-bb"><span class="identifier">null_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  39   <a class="link" href="null_mutex.html#idp67137440-bb"><span class="special">~</span><span class="identifier">null_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  40
  41   <span class="comment">// <a class="link" href="null_mutex.html#idp67106896-bb">public member functions</a></span>
  42   <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp67107456-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  43   <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp67108624-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  44   <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp67109936-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>
  45   <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp67111952-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  46   <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp67113248-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  47   <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp67114560-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  48   <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp67115888-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>
  49   <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp67117920-bb"><span class="identifier">unlock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  50   <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp67119232-bb"><span class="identifier">lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  51   <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp67120544-bb"><span class="identifier">try_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  52   <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp67121872-bb"><span class="identifier">timed_lock_upgradable</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>
  53   <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp67123904-bb"><span class="identifier">unlock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  54   <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp67125216-bb"><span class="identifier">unlock_and_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  55   <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp67126544-bb"><span class="identifier">unlock_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  56   <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp67127856-bb"><span class="identifier">unlock_upgradable_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  57   <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp67129184-bb"><span class="identifier">unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  58   <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp67130512-bb"><span class="identifier">try_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  59   <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp67131856-bb"><span class="identifier">timed_unlock_upgradable_and_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>
  60   <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp67133904-bb"><span class="identifier">try_unlock_sharable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  61   <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp67135232-bb"><span class="identifier">try_unlock_sharable_and_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  62 <span class="special">}</span><span class="special">;</span></pre></div>
  63 <div class="refsect1">
  64 <a name="idp251127552"></a><h2>Description</h2>
  65 <p>Implements a mutex that simulates a mutex without doing any operation and simulates a successful operation. </p>
  66 <div class="refsect2">
  67 <a name="idp251128352"></a><h3>
  68 <a name="boost.interprocess.null_mutexconstruct-copy-destruct"></a><code class="computeroutput">null_mutex</code>
  69         public
  70        construct/copy/destruct</h3>
  71 <div class="orderedlist"><ol class="orderedlist" type="1">
  72 <li class="listitem">
  73 <pre class="literallayout"><a name="idp67136736-bb"></a><span class="identifier">null_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  74 <p>Constructor. Empty. </p>
  75 </li>
  76 <li class="listitem">
  77 <pre class="literallayout"><a name="idp67137440-bb"></a><span class="special">~</span><span class="identifier">null_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  78 <p>Destructor. Empty. </p>
  79 </li>
  80 </ol></div>
  81 </div>
  82 <div class="refsect2">
  83 <a name="idp251138960"></a><h3>
  84 <a name="idp67106896-bb"></a><code class="computeroutput">null_mutex</code> public member functions</h3>
  85 <div class="orderedlist"><ol class="orderedlist" type="1">
  86 <li class="listitem">
  87 <pre class="literallayout"><span class="keyword">void</span> <a name="idp67107456-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Simulates a mutex lock() operation. Empty function. </li>
  88 <li class="listitem">
  89 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp67108624-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  90 <p>Simulates a mutex try_lock() operation. Equivalent to "return true;" </p>
  91 </li>
  92 <li class="listitem">
  93 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp67109936-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><span class="special">)</span><span class="special">;</span></pre>
  94 <p>Simulates a mutex timed_lock() operation. Equivalent to "return true;" </p>
  95 </li>
  96 <li class="listitem">
  97 <pre class="literallayout"><span class="keyword">void</span> <a name="idp67111952-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  98 <p>Simulates a mutex unlock() operation. Empty function. </p>
  99 </li>
 100 <li class="listitem">
 101 <pre class="literallayout"><span class="keyword">void</span> <a name="idp67113248-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 102 <p>Simulates a mutex lock_sharable() operation. Empty function. </p>
 103 </li>
 104 <li class="listitem">
 105 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp67114560-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 106 <p>Simulates a mutex try_lock_sharable() operation. Equivalent to "return true;" </p>
 107 </li>
 108 <li class="listitem">
 109 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp67115888-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><span class="special">)</span><span class="special">;</span></pre>
 110 <p>Simulates a mutex timed_lock_sharable() operation. Equivalent to "return true;" </p>
 111 </li>
 112 <li class="listitem">
 113 <pre class="literallayout"><span class="keyword">void</span> <a name="idp67117920-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 114 <p>Simulates a mutex unlock_sharable() operation. Empty function. </p>
 115 </li>
 116 <li class="listitem">
 117 <pre class="literallayout"><span class="keyword">void</span> <a name="idp67119232-bb"></a><span class="identifier">lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 118 <p>Simulates a mutex lock_upgradable() operation. Empty function. </p>
 119 </li>
 120 <li class="listitem">
 121 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp67120544-bb"></a><span class="identifier">try_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 122 <p>Simulates a mutex try_lock_upgradable() operation. Equivalent to "return true;" </p>
 123 </li>
 124 <li class="listitem">
 125 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp67121872-bb"></a><span class="identifier">timed_lock_upgradable</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><span class="special">)</span><span class="special">;</span></pre>
 126 <p>Simulates a mutex timed_lock_upgradable() operation. Equivalent to "return true;" </p>
 127 </li>
 128 <li class="listitem">
 129 <pre class="literallayout"><span class="keyword">void</span> <a name="idp67123904-bb"></a><span class="identifier">unlock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 130 <p>Simulates a mutex unlock_upgradable() operation. Empty function. </p>
 131 </li>
 132 <li class="listitem">
 133 <pre class="literallayout"><span class="keyword">void</span> <a name="idp67125216-bb"></a><span class="identifier">unlock_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 134 <p>Simulates unlock_and_lock_upgradable(). Empty function. </p>
 135 </li>
 136 <li class="listitem">
 137 <pre class="literallayout"><span class="keyword">void</span> <a name="idp67126544-bb"></a><span class="identifier">unlock_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 138 <p>Simulates unlock_and_lock_sharable(). Empty function. </p>
 139 </li>
 140 <li class="listitem">
 141 <pre class="literallayout"><span class="keyword">void</span> <a name="idp67127856-bb"></a><span class="identifier">unlock_upgradable_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 142 <p>Simulates unlock_upgradable_and_lock_sharable(). Empty function. </p>
 143 </li>
 144 <li class="listitem">
 145 <pre class="literallayout"><span class="keyword">void</span> <a name="idp67129184-bb"></a><span class="identifier">unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 146 <p>Simulates unlock_upgradable_and_lock(). Empty function. </p>
 147 </li>
 148 <li class="listitem">
 149 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp67130512-bb"></a><span class="identifier">try_unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 150 <p>Simulates try_unlock_upgradable_and_lock(). Equivalent to "return true;" </p>
 151 </li>
 152 <li class="listitem">
 153 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp67131856-bb"></a><span class="identifier">timed_unlock_upgradable_and_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><span class="special">)</span><span class="special">;</span></pre>
 154 <p>Simulates timed_unlock_upgradable_and_lock(). Equivalent to "return true;" </p>
 155 </li>
 156 <li class="listitem">
 157 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp67133904-bb"></a><span class="identifier">try_unlock_sharable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 158 <p>Simulates try_unlock_sharable_and_lock(). Equivalent to "return true;" </p>
 159 </li>
 160 <li class="listitem">
 161 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp67135232-bb"></a><span class="identifier">try_unlock_sharable_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 162 <p>Simulates try_unlock_sharable_and_lock_upgradable(). Equivalent to "return true;" </p>
 163 </li>
 164 </ol></div>
 165 </div>
 166 </div>
 167 </div>
 168 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 169 <td align="left"></td>
 170 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2012 Ion Gaztanaga<p>
 171         Distributed under the Boost Software License, Version 1.0. (See accompanying
 172         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 173       </p>
 174 </div></td>
 175 </tr></table>
 176 <hr>
 177 <div class="spirit-nav">
 178 <a accesskey="p" href="named_upgradable_mutex.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.null_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="scoped_lock.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 179 </div>
 180 </body>
 181 </html>