Chris@16: /*
Chris@101:  *          Copyright Andrey Semashev 2007 - 2015.
Chris@16:  * Distributed under the Boost Software License, Version 1.0.
Chris@16:  *    (See accompanying file LICENSE_1_0.txt or copy at
Chris@16:  *          http://www.boost.org/LICENSE_1_0.txt)
Chris@16:  */
Chris@16: /*!
Chris@16:  * \file   sources/threading_models.hpp
Chris@16:  * \author Andrey Semashev
Chris@16:  * \date   04.10.2008
Chris@16:  *
Chris@16:  * The header contains definition of threading models that can be used in loggers.
Chris@16:  * The header also provides a number of tags that can be used to express lock requirements
Chris@16:  * on a function callee.
Chris@16:  */
Chris@16: 
Chris@16: #ifndef BOOST_LOG_SOURCES_THREADING_MODELS_HPP_INCLUDED_
Chris@16: #define BOOST_LOG_SOURCES_THREADING_MODELS_HPP_INCLUDED_
Chris@16: 
Chris@16: #include <boost/log/detail/config.hpp>
Chris@16: #include <boost/log/detail/locks.hpp> // is_mutex_type
Chris@16: #if !defined(BOOST_LOG_NO_THREADS)
Chris@16: #include <boost/mpl/bool.hpp>
Chris@16: #endif
Chris@16: #include <boost/log/detail/header.hpp>
Chris@16: 
Chris@16: #ifdef BOOST_HAS_PRAGMA_ONCE
Chris@16: #pragma once
Chris@16: #endif
Chris@16: 
Chris@16: namespace boost {
Chris@16: 
Chris@16: BOOST_LOG_OPEN_NAMESPACE
Chris@16: 
Chris@16: namespace sources {
Chris@16: 
Chris@16: //! Single thread locking model
Chris@16: struct single_thread_model
Chris@16: {
Chris@16:     // We provide methods for the most advanced locking concept: UpgradeLockable
Chris@16:     void lock_shared() const {}
Chris@16:     bool try_lock_shared() const { return true; }
Chris@16:     template< typename TimeT >
Chris@16:     bool timed_lock_shared(TimeT const&) const { return true; }
Chris@16:     void unlock_shared() const {}
Chris@16:     void lock() const {}
Chris@16:     bool try_lock() const { return true; }
Chris@16:     template< typename TimeT >
Chris@16:     bool timed_lock(TimeT const&) const { return true; }
Chris@16:     void unlock() const {}
Chris@16:     void lock_upgrade() const {}
Chris@16:     bool try_lock_upgrade() const { return true; }
Chris@16:     template< typename TimeT >
Chris@16:     bool timed_lock_upgrade(TimeT const&) const { return true; }
Chris@16:     void unlock_upgrade() const {}
Chris@16:     void unlock_upgrade_and_lock() const {}
Chris@16:     void unlock_and_lock_upgrade() const {}
Chris@16:     void unlock_and_lock_shared() const {}
Chris@16:     void unlock_upgrade_and_lock_shared() const {}
Chris@16: 
Chris@16:     void swap(single_thread_model&) {}
Chris@16: };
Chris@16: 
Chris@16: #if !defined(BOOST_LOG_NO_THREADS)
Chris@16: 
Chris@16: //! Multi-thread locking model with maximum locking capabilities
Chris@16: template< typename MutexT >
Chris@16: struct multi_thread_model
Chris@16: {
Chris@16:     multi_thread_model() {}
Chris@16:     multi_thread_model(multi_thread_model const&) {}
Chris@16:     multi_thread_model& operator= (multi_thread_model const&) { return *this; }
Chris@16: 
Chris@16:     void lock_shared() const { m_Mutex.lock_shared(); }
Chris@16:     bool try_lock_shared() const { return m_Mutex.try_lock_shared(); }
Chris@16:     template< typename TimeT >
Chris@16:     bool timed_lock_shared(TimeT const& t) const { return m_Mutex.timed_lock_shared(t); }
Chris@16:     void unlock_shared() const { m_Mutex.unlock_shared(); }
Chris@16:     void lock() const { m_Mutex.lock(); }
Chris@16:     bool try_lock() const { return m_Mutex.try_lock(); }
Chris@16:     template< typename TimeT >
Chris@16:     bool timed_lock(TimeT const& t) const { return m_Mutex.timed_lock(t); }
Chris@16:     void unlock() const { m_Mutex.unlock(); }
Chris@16:     void lock_upgrade() const { m_Mutex.lock_upgrade(); }
Chris@16:     bool try_lock_upgrade() const { return m_Mutex.try_lock_upgrade(); }
Chris@16:     template< typename TimeT >
Chris@16:     bool timed_lock_upgrade(TimeT const& t) const { return m_Mutex.timed_lock_upgrade(t); }
Chris@16:     void unlock_upgrade() const { m_Mutex.unlock_upgrade(); }
Chris@16:     void unlock_upgrade_and_lock() const { m_Mutex.unlock_upgrade_and_lock(); }
Chris@16:     void unlock_and_lock_upgrade() const { m_Mutex.unlock_and_lock_upgrade(); }
Chris@16:     void unlock_and_lock_shared() const { m_Mutex.unlock_and_lock_shared(); }
Chris@16:     void unlock_upgrade_and_lock_shared() const { m_Mutex.unlock_upgrade_and_lock_shared(); }
Chris@16: 
Chris@16:     void swap(multi_thread_model&) {}
Chris@16: 
Chris@16: private:
Chris@16:     //! Synchronization primitive
Chris@16:     mutable MutexT m_Mutex;
Chris@16: };
Chris@16: 
Chris@16: #endif // !defined(BOOST_LOG_NO_THREADS)
Chris@16: 
Chris@16: } // namespace sources
Chris@16: 
Chris@16: BOOST_LOG_CLOSE_NAMESPACE // namespace log
Chris@16: 
Chris@16: #if !defined(BOOST_LOG_NO_THREADS) && !defined(BOOST_LOG_DOXYGEN_PASS)
Chris@16: 
Chris@16: template< >
Chris@16: struct is_mutex_type< boost::log::sources::single_thread_model > : mpl::true_
Chris@16: {
Chris@16: };
Chris@16: 
Chris@16: template< typename T >
Chris@16: struct is_mutex_type< boost::log::sources::multi_thread_model< T > > : mpl::true_
Chris@16: {
Chris@16: };
Chris@16: 
Chris@16: #endif // !defined(BOOST_LOG_NO_THREADS)
Chris@16: 
Chris@16: } // namespace boost
Chris@16: 
Chris@16: #include <boost/log/detail/footer.hpp>
Chris@16: 
Chris@16: #endif // BOOST_LOG_SOURCES_THREADING_MODELS_HPP_INCLUDED_