ceph/src/boost/libs/signals2/doc/reference/dummy_mutex.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE header PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
   3   "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
   4 <!--
   5 Copyright Frank Mori Hess 2008-2009
   6
   7 Distributed under the Boost Software License, Version 1.0. (See accompanying
   8 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   9 -->
  10 <header name="boost/signals2/dummy_mutex.hpp" last-revision="$Date: 2007-03-06 16:51:55 -0500 (Tue, 06 Mar 2007) $">
  11   <using-namespace name="boost::signals2"/>
  12   <using-namespace name="boost"/>
  13   <namespace name="boost">
  14     <namespace name="signals2">
  15       <class name="dummy_mutex">
  16         <inherit access="public">
  17           <type><classname>noncopyable</classname></type>
  18         </inherit>
  19         <purpose>Fake mutex which does nothing.</purpose>
  20         <description>
  21           <para>You may wish to use the <code>dummy_mutex</code> class for the <code>Mutex</code>
  22           template type of your signals if you are not concerned about thread safety.
  23           This may give slightly faster
  24           performance, since <code>dummy_mutex</code> performs no actual locking.
  25           </para>
  26         </description>
  27         <access name="public">
  28           <method name="lock">
  29             <type>void</type>
  30             <description>
  31               <para>No effect.
  32               </para>
  33             </description>
  34           </method>
  35           <method name="try_lock">
  36             <type>bool</type>
  37             <description>
  38               <para>No effect.
  39               </para>
  40             </description>
  41             <returns><para><code>true</code>.</para></returns>
  42           </method>
  43           <method name="unlock">
  44             <type>void</type>
  45             <description>
  46               <para>No effect.
  47               </para>
  48             </description>
  49           </method>
  50         </access>
  51      </class>
  52     </namespace>
  53   </namespace>
  54 </header>