Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: //
Chris@16: // (C) Copyright Vicente J. Botet Escriba 2008-2009,2012. Distributed under the Boost
Chris@16: // Software License, Version 1.0. (See accompanying file
Chris@16: // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16: //
Chris@16: // See http://www.boost.org/libs/thread for documentation.
Chris@16: //
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16: #ifndef BOOST_THREAD_NULL_MUTEX_HPP
Chris@16: #define BOOST_THREAD_NULL_MUTEX_HPP
Chris@16: 
Chris@16: #include <boost/thread/detail/config.hpp>
Chris@16: #include <boost/thread/detail/delete.hpp>
Chris@16: #include <boost/chrono/chrono.hpp>
Chris@16: 
Chris@16: /// \file
Chris@16: /// Describes null_mutex class
Chris@16: 
Chris@16: namespace boost
Chris@16: {
Chris@16: 
Chris@16:   /// Implements a mutex that simulates a mutex without doing any operation and
Chris@16:   /// simulates a successful operation.
Chris@16:   class null_mutex
Chris@16:   {
Chris@16:   public:
Chris@16: 
Chris@16:     BOOST_THREAD_NO_COPYABLE( null_mutex) /*< no copyable >*/
Chris@16: 
Chris@16:     null_mutex() {}
Chris@16: 
Chris@16:     /// Simulates a mutex lock() operation. Empty function.
Chris@16:     void lock()
Chris@16:     {
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_lock() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     bool try_lock()
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex unlock() operation.
Chris@16:     /// Empty function.
Chris@16:     void unlock()
Chris@16:     {
Chris@16:     }
Chris@16: 
Chris@16: #ifdef BOOST_THREAD_USES_CHRONO
Chris@16:     /// Simulates a mutex try_lock_until() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     template <typename Clock, typename Duration>
Chris@16:     bool try_lock_until(chrono::time_point<Clock, Duration> const &)
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_lock_for() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     template <typename Rep, typename Period>
Chris@16:     bool try_lock_for(chrono::duration<Rep, Period> const &)
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: #endif
Chris@16: 
Chris@16:     /// Simulates a mutex lock_shared() operation.
Chris@16:     /// Empty function.
Chris@16:     void lock_shared()
Chris@16:     {
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_lock_shared() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     bool try_lock_shared()
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex unlock_shared() operation.
Chris@16:     /// Empty function.
Chris@16:     void unlock_shared()
Chris@16:     {
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_lock_shared_until() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     template <typename Clock, typename Duration>
Chris@16:     bool try_lock_shared_until(chrono::time_point<Clock, Duration> const &)
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16:     /// Simulates a mutex try_lock_shared_for() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     template <typename Rep, typename Period>
Chris@16:     bool try_lock_shared_for(chrono::duration<Rep, Period> const &)
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex lock_upgrade() operation.
Chris@16:     /// Empty function.
Chris@16:     void lock_upgrade()
Chris@16:     {
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_lock_upgrade() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     bool try_lock_upgrade()
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex unlock_upgrade() operation.
Chris@16:     /// Empty function.
Chris@16:     void unlock_upgrade()
Chris@16:     {
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_lock_upgrade_until() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     template <typename Clock, typename Duration>
Chris@16:     bool try_lock_upgrade_until(chrono::time_point<Clock, Duration> const &)
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_lock_upgrade_for() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     template <typename Rep, typename Period>
Chris@16:     bool try_lock_upgrade_for(chrono::duration<Rep, Period> const &)
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_unlock_shared_and_lock() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     bool try_unlock_shared_and_lock()
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16: #ifdef BOOST_THREAD_USES_CHRONO
Chris@16:     /// Simulates a mutex try_unlock_shared_and_lock_until() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     template <typename Clock, typename Duration>
Chris@16:     bool try_unlock_shared_and_lock_until(chrono::time_point<Clock, Duration> const &)
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_unlock_shared_and_lock_for() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     template <typename Rep, typename Period>
Chris@16:     bool try_unlock_shared_and_lock_for(chrono::duration<Rep, Period> const &)
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: #endif
Chris@16: 
Chris@16:     /// Simulates unlock_and_lock_shared().
Chris@16:     /// Empty function.
Chris@16:     void unlock_and_lock_shared()
Chris@16:     {
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_unlock_shared_and_lock_upgrade() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     bool try_unlock_shared_and_lock_upgrade()
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16: #ifdef BOOST_THREAD_USES_CHRONO
Chris@16:     /// Simulates a mutex try_unlock_shared_and_lock_upgrade_until() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     template <typename Clock, typename Duration>
Chris@16:     bool try_unlock_shared_and_lock_upgrade_until(chrono::time_point<Clock, Duration> const &)
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_unlock_shared_and_lock_upgrade_for() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     template <typename Rep, typename Period>
Chris@16:     bool try_unlock_shared_and_lock_upgrade_for(chrono::duration<Rep, Period> const &)
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: #endif
Chris@16: 
Chris@16:     /// Simulates unlock_and_lock_upgrade().
Chris@16:     /// Empty function.
Chris@16:     void unlock_and_lock_upgrade()
Chris@16:     {
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates unlock_upgrade_and_lock().
Chris@16:     /// Empty function.
Chris@16:     void unlock_upgrade_and_lock()
Chris@16:     {
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_unlock_upgrade_and_lock() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     bool try_unlock_upgrade_and_lock()
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16: #ifdef BOOST_THREAD_USES_CHRONO
Chris@16:     /// Simulates a mutex try_unlock_upgrade_and_lock_until() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     template <typename Clock, typename Duration>
Chris@16:     bool try_unlock_upgrade_and_lock_until(chrono::time_point<Clock, Duration> const &)
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: 
Chris@16:     /// Simulates a mutex try_unlock_upgrade_and_lock_for() operation.
Chris@16:     /// Equivalent to "return true;"
Chris@16:     template <typename Rep, typename Period>
Chris@16:     bool try_unlock_upgrade_and_lock_for(chrono::duration<Rep, Period> const &)
Chris@16:     {
Chris@16:       return true;
Chris@16:     }
Chris@16: #endif
Chris@16: 
Chris@16:     /// Simulates unlock_upgrade_and_lock_shared().
Chris@16:     /// Empty function.
Chris@16:     void unlock_upgrade_and_lock_shared()
Chris@16:     {
Chris@16:     }
Chris@16: 
Chris@16:   };
Chris@16: 
Chris@16: } //namespace boost {
Chris@16: 
Chris@16: 
Chris@16: #endif