| ////////////////////////////////////////////////////////////////////////////// |
| // |
| // (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_MUTEX_HPP |
| #define BOOST_INTERPROCESS_SHM_NAMED_MUTEX_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/creation_tags.hpp> |
| #include <boost/interprocess/exceptions.hpp> |
| #include <boost/interprocess/detail/interprocess_tester.hpp> |
| #include <boost/interprocess/permissions.hpp> |
| #include <boost/interprocess/detail/posix_time_types_wrk.hpp> |
| |
| #include <boost/interprocess/shared_memory_object.hpp> |
| #include <boost/interprocess/sync/interprocess_mutex.hpp> |
| #include <boost/interprocess/detail/managed_open_or_create_impl.hpp> |
| #include <boost/interprocess/sync/shm/named_creation_functor.hpp> |
| |
| //!\file |
| //!Describes a named mutex class for inter-process synchronization |
| |
| namespace boost { |
| namespace interprocess { |
| namespace ipcdetail { |
| |
| class named_condition; |
| |
| //!A mutex with a global name, so it can be found from different |
| //!processes. This mutex can't be placed in shared memory, and |
| //!each process should have it's own named mutex. |
| class shm_named_mutex |
| { |
| #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED) |
| |
| //Non-copyable |
| shm_named_mutex(); |
| shm_named_mutex(const shm_named_mutex &); |
| shm_named_mutex &operator=(const shm_named_mutex &); |
| friend class named_condition; |
| #endif //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED |
| |
| public: |
| //!Creates a global interprocess_mutex with a name. |
| //!Throws interprocess_exception on error. |
| shm_named_mutex(create_only_t create_only, const char *name, const permissions &perm = permissions()); |
| |
| //!Opens or creates a global mutex with a name. |
| //!If the mutex is created, this call is equivalent to |
| //!shm_named_mutex(create_only_t, ... ) |
| //!If the mutex is already created, this call is equivalent |
| //!shm_named_mutex(open_only_t, ... ) |
| //!Does not throw |
| shm_named_mutex(open_or_create_t open_or_create, const char *name, const permissions &perm = permissions()); |
| |
| //!Opens a global mutex with a name if that mutex is previously |
| //!created. If it is not previously created this function throws |
| //!interprocess_exception. |
| shm_named_mutex(open_only_t open_only, const char *name); |
| |
| //!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_mutex(); |
| |
| //!Unlocks a previously locked |
| //!interprocess_mutex. |
| void unlock(); |
| |
| //!Locks interprocess_mutex, sleeps when interprocess_mutex is already locked. |
| //!Throws interprocess_exception if a severe error is found |
| void lock(); |
| |
| //!Tries to lock the interprocess_mutex, returns false when interprocess_mutex |
| //!is already locked, returns true when success. |
| //!Throws interprocess_exception if a severe error is found |
| bool try_lock(); |
| |
| //!Tries to lock the interprocess_mutex until time abs_time, |
| //!Returns false when timeout expires, returns true when locks. |
| //!Throws interprocess_exception if a severe error is found |
| bool timed_lock(const boost::posix_time::ptime &abs_time); |
| |
| //!Erases a named mutex from the system. |
| //!Returns false on error. Never throws. |
| static bool remove(const char *name); |
| |
| #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED) |
| typedef interprocess_mutex internal_mutex_type; |
| interprocess_mutex &internal_mutex() |
| { return *static_cast<interprocess_mutex*>(m_shmem.get_user_address()); } |
| |
| private: |
| friend class ipcdetail::interprocess_tester; |
| void dont_close_on_destruction(); |
| typedef ipcdetail::managed_open_or_create_impl<shared_memory_object, 0, true, false> open_create_impl_t; |
| open_create_impl_t m_shmem; |
| typedef ipcdetail::named_creation_functor<interprocess_mutex> construct_func_t; |
| #endif //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED |
| }; |
| |
| #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED) |
| |
| inline void shm_named_mutex::dont_close_on_destruction() |
| { ipcdetail::interprocess_tester::dont_close_on_destruction(m_shmem); } |
| |
| inline shm_named_mutex::~shm_named_mutex() |
| {} |
| |
| inline shm_named_mutex::shm_named_mutex(create_only_t, const char *name, const permissions &perm) |
| : m_shmem (create_only |
| ,name |
| ,sizeof(interprocess_mutex) + |
| open_create_impl_t::ManagedOpenOrCreateUserOffset |
| ,read_write |
| ,0 |
| ,construct_func_t(ipcdetail::DoCreate) |
| ,perm) |
| {} |
| |
| inline shm_named_mutex::shm_named_mutex(open_or_create_t, const char *name, const permissions &perm) |
| : m_shmem (open_or_create |
| ,name |
| ,sizeof(interprocess_mutex) + |
| open_create_impl_t::ManagedOpenOrCreateUserOffset |
| ,read_write |
| ,0 |
| ,construct_func_t(ipcdetail::DoOpenOrCreate) |
| ,perm) |
| {} |
| |
| inline shm_named_mutex::shm_named_mutex(open_only_t, const char *name) |
| : m_shmem (open_only |
| ,name |
| ,read_write |
| ,0 |
| ,construct_func_t(ipcdetail::DoOpen)) |
| {} |
| |
| inline void shm_named_mutex::lock() |
| { this->internal_mutex().lock(); } |
| |
| inline void shm_named_mutex::unlock() |
| { this->internal_mutex().unlock(); } |
| |
| inline bool shm_named_mutex::try_lock() |
| { return this->internal_mutex().try_lock(); } |
| |
| inline bool shm_named_mutex::timed_lock(const boost::posix_time::ptime &abs_time) |
| { return this->internal_mutex().timed_lock(abs_time); } |
| |
| inline bool shm_named_mutex::remove(const char *name) |
| { return shared_memory_object::remove(name); } |
| |
| #endif //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED |
| |
| } //namespace ipcdetail { |
| } //namespace interprocess { |
| } //namespace boost { |
| |
| #include <boost/interprocess/detail/config_end.hpp> |
| |
| #endif //BOOST_INTERPROCESS_SHM_NAMED_MUTEX_HPP |