boost/interprocess/sync/shm/named_condition_any.hpp
////////////////////////////////////////////////////////////////////////////// // // (C) Copyright Ion Gaztanaga 2005-2012. Distributed under the Boost // Software License, Version 1.0. (See accompanying file // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) // // See http://www.boost.org/libs/interprocess for documentation. // ////////////////////////////////////////////////////////////////////////////// #ifndef BOOST_INTERPROCESS_SHM_NAMED_CONDITION_ANY_HPP #define BOOST_INTERPROCESS_SHM_NAMED_CONDITION_ANY_HPP #ifndef BOOST_CONFIG_HPP # include <boost/config.hpp> #endif # #if defined(BOOST_HAS_PRAGMA_ONCE) # pragma once #endif #include <boost/interprocess/detail/config_begin.hpp> #include <boost/interprocess/detail/workaround.hpp> #include <boost/interprocess/sync/cv_status.hpp> #include <boost/static_assert.hpp> #include <boost/interprocess/detail/type_traits.hpp> #include <boost/interprocess/creation_tags.hpp> #include <boost/interprocess/exceptions.hpp> #include <boost/interprocess/shared_memory_object.hpp> #include <boost/interprocess/sync/interprocess_condition.hpp> #include <boost/interprocess/detail/managed_open_or_create_impl.hpp> #include <boost/interprocess/sync/shm/named_creation_functor.hpp> #include <boost/interprocess/sync/named_mutex.hpp> #include <boost/interprocess/permissions.hpp> #include <boost/interprocess/sync/interprocess_mutex.hpp> #include <boost/interprocess/sync/scoped_lock.hpp> #include <boost/interprocess/sync/detail/condition_any_algorithm.hpp> //!\file //!Describes process-shared variables interprocess_condition class namespace boost { namespace interprocess { namespace ipcdetail { #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED) class interprocess_tester; #endif //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED //! A global condition variable that can be created by name. //! This condition variable is designed to work with named_mutex and //! can't be placed in shared memory or memory mapped files. class shm_named_condition_any { #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED) //Non-copyable shm_named_condition_any(); shm_named_condition_any(const shm_named_condition_any &); shm_named_condition_any &operator=(const shm_named_condition_any &); #endif //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED public: //!Creates a global condition with a name. //!If the condition can't be created throws interprocess_exception template <class CharT> shm_named_condition_any(create_only_t, const CharT *name, const permissions &perm = permissions()) : m_shmem (create_only_t() ,name ,sizeof(internal_condition) + open_create_impl_t::ManagedOpenOrCreateUserOffset ,read_write ,0 ,construct_func_t(DoCreate) ,perm) {} //!Opens or creates a global condition with a name. //!If the condition is created, this call is equivalent to //!shm_named_condition_any(create_only_t, ... ) //!If the condition is already created, this call is equivalent //!shm_named_condition_any(open_only_t, ... ) //!Does not throw template <class CharT> shm_named_condition_any(open_or_create_t, const CharT *name, const permissions &perm = permissions()) : m_shmem (open_or_create_t() ,name ,sizeof(internal_condition) + open_create_impl_t::ManagedOpenOrCreateUserOffset ,read_write ,0 ,construct_func_t(DoOpenOrCreate) ,perm) {} //!Opens a global condition with a name if that condition is previously //!created. If it is not previously created this function throws //!interprocess_exception. template <class CharT> shm_named_condition_any(open_only_t, const CharT *name) : m_shmem (open_only_t() ,name ,read_write ,0 ,construct_func_t(DoOpen)) {} //!Destroys *this and indicates that the calling process is finished using //!the resource. The destructor function will deallocate //!any system resources allocated by the system for use by this process for //!this resource. The resource can still be opened again calling //!the open constructor overload. To erase the resource from the system //!use remove(). ~shm_named_condition_any() {} //!If there is a thread waiting on *this, change that //!thread's state to ready. Otherwise there is no effect.*/ void notify_one() { this->internal_cond().notify_one(); } //!Change the state of all threads waiting on *this to ready. //!If there are no waiting threads, notify_all() has no effect. void notify_all() { this->internal_cond().notify_all(); } //!Releases the lock on the named_mutex object associated with lock, blocks //!the current thread of execution until readied by a call to //!this->notify_one() or this->notify_all(), and then reacquires the lock. template <typename L> void wait(L& lock) { this->internal_cond().wait(lock); } //!The same as: //!while (!pred()) wait(lock) template <typename L, typename Pr> void wait(L& lock, Pr pred) { this->internal_cond().wait(lock, pred); } //!Releases the lock on the named_mutex object associated with lock, blocks //!the current thread of execution until readied by a call to //!this->notify_one() or this->notify_all(), or until time abs_time is reached, //!and then reacquires the lock. //!Returns: false if time abs_time is reached, otherwise true. template <typename L, typename TimePoint> bool timed_wait(L& lock, const TimePoint &abs_time) { return this->internal_cond().timed_wait(lock, abs_time); } //!The same as: while (!pred()) { //! if (!timed_wait(lock, abs_time)) return pred(); //! } return true; template <typename L, typename TimePoint, typename Pr> bool timed_wait(L& lock, const TimePoint &abs_time, Pr pred) { return this->internal_cond().timed_wait(lock, abs_time, pred); } //!Same as `timed_wait`, but this function is modeled after the //!standard library interface. template <typename L, class TimePoint> cv_status wait_until(L& lock, const TimePoint &abs_time) { return this->timed_wait(lock, abs_time) ? cv_status::no_timeout : cv_status::timeout; } //!Same as `timed_wait`, but this function is modeled after the //!standard library interface. template <typename L, class TimePoint, typename Pr> bool wait_until(L& lock, const TimePoint &abs_time, Pr pred) { return this->timed_wait(lock, abs_time, pred); } //!Same as `timed_wait`, but this function is modeled after the //!standard library interface and uses relative timeouts. template <typename L, class Duration> cv_status wait_for(L& lock, const Duration &dur) { return this->wait_until(lock, ipcdetail::duration_to_ustime(dur)); } //!Same as `timed_wait`, but this function is modeled after the //!standard library interface and uses relative timeouts template <typename L, class Duration, typename Pr> bool wait_for(L& lock, const Duration &dur, Pr pred) { return this->wait_until(lock, ipcdetail::duration_to_ustime(dur), pred); } //!Erases a named condition from the system. //!Returns false on error. Never throws. template <class CharT> static bool remove(const CharT *name) { return shared_memory_object::remove(name); } #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED) private: class internal_condition_members { public: typedef interprocess_mutex mutex_type; typedef interprocess_condition condvar_type; condvar_type& get_condvar() { return m_cond; } mutex_type& get_mutex() { return m_mtx; } private: mutex_type m_mtx; condvar_type m_cond; }; typedef ipcdetail::condition_any_wrapper<internal_condition_members> internal_condition; internal_condition &internal_cond() { return *static_cast<internal_condition*>(m_shmem.get_user_address()); } friend class boost::interprocess::ipcdetail::interprocess_tester; void dont_close_on_destruction() { interprocess_tester::dont_close_on_destruction(m_shmem); } typedef ipcdetail::managed_open_or_create_impl<shared_memory_object, 0, true, false> open_create_impl_t; open_create_impl_t m_shmem; template <class T, class Arg> friend class boost::interprocess::ipcdetail::named_creation_functor; typedef boost::interprocess::ipcdetail::named_creation_functor<internal_condition> construct_func_t; #endif //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED }; } //namespace ipcdetail } //namespace interprocess } //namespace boost #include <boost/interprocess/detail/config_end.hpp> #endif // BOOST_INTERPROCESS_SHM_NAMED_CONDITION_ANY_HPP