00001 /* ///////////////////////////////////////////////////////////////////////// 00002 * File: stlsoft/synch/null_mutex.hpp (originally MLMutex.h, ::SynesisStd) 00003 * 00004 * Purpose: Mutual exclusion model class. 00005 * 00006 * Created: 19th December 1997 00007 * Updated: 10th August 2009 00008 * 00009 * Home: http://stlsoft.org/ 00010 * 00011 * Copyright (c) 1997-2009, Matthew Wilson and Synesis Software 00012 * All rights reserved. 00013 * 00014 * Redistribution and use in source and binary forms, with or without 00015 * modification, are permitted provided that the following conditions are met: 00016 * 00017 * - Redistributions of source code must retain the above copyright notice, this 00018 * list of conditions and the following disclaimer. 00019 * - Redistributions in binary form must reproduce the above copyright notice, 00020 * this list of conditions and the following disclaimer in the documentation 00021 * and/or other materials provided with the distribution. 00022 * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of 00023 * any contributors may be used to endorse or promote products derived from 00024 * this software without specific prior written permission. 00025 * 00026 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00027 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00028 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 00029 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 00030 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 00031 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 00032 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 00033 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 00034 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 00035 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 00036 * POSSIBILITY OF SUCH DAMAGE. 00037 * 00038 * ////////////////////////////////////////////////////////////////////// */ 00039 00040 00047 #ifndef STLSOFT_INCL_STLSOFT_SYNCH_HPP_NULL_MUTEX 00048 #define STLSOFT_INCL_STLSOFT_SYNCH_HPP_NULL_MUTEX 00049 00050 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION 00051 # define STLSOFT_VER_STLSOFT_SYNCH_HPP_NULL_MUTEX_MAJOR 4 00052 # define STLSOFT_VER_STLSOFT_SYNCH_HPP_NULL_MUTEX_MINOR 0 00053 # define STLSOFT_VER_STLSOFT_SYNCH_HPP_NULL_MUTEX_REVISION 1 00054 # define STLSOFT_VER_STLSOFT_SYNCH_HPP_NULL_MUTEX_EDIT 41 00055 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ 00056 00057 /* ///////////////////////////////////////////////////////////////////////// 00058 * Includes 00059 */ 00060 00061 #ifndef STLSOFT_INCL_STLSOFT_H_STLSOFT 00062 # include <stlsoft/stlsoft.h> 00063 #endif /* !STLSOFT_INCL_STLSOFT_H_STLSOFT */ 00064 #ifndef STLSOFT_INCL_STLSOFT_SYNCH_HPP_CONCEPTS 00065 # include <stlsoft/synch/concepts.hpp> 00066 #endif /* !STLSOFT_INCL_STLSOFT_SYNCH_HPP_CONCEPTS */ 00067 00068 /* ///////////////////////////////////////////////////////////////////////// 00069 * Namespace 00070 */ 00071 00072 #ifndef _STLSOFT_NO_NAMESPACE 00073 namespace stlsoft 00074 { 00075 #endif /* _STLSOFT_NO_NAMESPACE */ 00076 00077 /* ///////////////////////////////////////////////////////////////////////// 00078 * Classes 00079 */ 00080 00081 // class null_mutex 00082 00087 class null_mutex 00088 : public critical_section< STLSOFT_CRITICAL_SECTION_IS_RECURSIVE 00089 , STLSOFT_CRITICAL_SECTION_ISNOT_TRYABLE 00090 > 00091 { 00094 public: 00095 typedef null_mutex class_type; 00097 00100 public: 00102 null_mutex() stlsoft_throw_0() 00103 {} 00105 00108 public: 00110 void lock() stlsoft_throw_0() 00111 {} 00113 void unlock() stlsoft_throw_0() 00114 {} 00116 00119 private: 00120 null_mutex(class_type const& rhs); 00121 null_mutex& operator =(class_type const& rhs); 00123 }; 00124 00125 /* ///////////////////////////////////////////////////////////////////////// 00126 * Control shims 00127 */ 00128 00135 inline void lock_instance(stlsoft_ns_qual(null_mutex) &mx) 00136 { 00137 STLSOFT_SUPPRESS_UNUSED(mx); // This is used, instead of the preferred omission of parameter, since it upsets the documentation 00138 } 00139 00146 inline void unlock_instance(stlsoft_ns_qual(null_mutex) &mx) 00147 { 00148 STLSOFT_SUPPRESS_UNUSED(mx); // This is used, instead of the preferred omission of parameter, since it upsets the documentation 00149 } 00150 00152 // Unit-testing 00153 00154 #ifdef STLSOFT_UNITTEST 00155 # include "./unittest/null_mutex_unittest_.h" 00156 #endif /* STLSOFT_UNITTEST */ 00157 00158 /* ////////////////////////////////////////////////////////////////////// */ 00159 00160 #ifndef _STLSOFT_NO_NAMESPACE 00161 } // namespace stlsoft 00162 #endif /* _STLSOFT_NO_NAMESPACE */ 00163 00164 /* ////////////////////////////////////////////////////////////////////// */ 00165 00166 #endif /* !STLSOFT_INCL_STLSOFT_SYNCH_HPP_NULL_MUTEX */ 00167 00168 /* ///////////////////////////// end of file //////////////////////////// */