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