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_NAMED_RECURSIVE_MUTEX_HPP
Chris@16: #define BOOST_INTERPROCESS_NAMED_RECURSIVE_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/detail/posix_time_types_wrk.hpp>
Chris@16: #include <boost/interprocess/permissions.hpp>
Chris@16: #if !defined(BOOST_INTERPROCESS_FORCE_GENERIC_EMULATION) && defined (BOOST_INTERPROCESS_WINDOWS)
Chris@16:    #include <boost/interprocess/sync/windows/named_recursive_mutex.hpp>
Chris@16:    #define BOOST_INTERPROCESS_USE_WINDOWS
Chris@16: #else
Chris@16:    #include <boost/interprocess/sync/shm/named_recursive_mutex.hpp>
Chris@16: #endif
Chris@16: 
Chris@16: //!\file
Chris@16: //!Describes a named named_recursive_mutex class for inter-process synchronization
Chris@16: 
Chris@16: namespace boost {
Chris@16: namespace interprocess {
Chris@16: 
Chris@101: #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
Chris@16: namespace ipcdetail{ class interprocess_tester; }
Chris@101: #endif   //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
Chris@16: 
Chris@16: //!A recursive 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_recursive_mutex.
Chris@16: class named_recursive_mutex
Chris@16: {
Chris@101:    #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
Chris@16:    //Non-copyable
Chris@16:    named_recursive_mutex();
Chris@16:    named_recursive_mutex(const named_recursive_mutex &);
Chris@16:    named_recursive_mutex &operator=(const named_recursive_mutex &);
Chris@101:    #endif   //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
Chris@16:    public:
Chris@16: 
Chris@16:    //!Creates a global recursive_mutex with a name.
Chris@16:    //!If the recursive_mutex can't be created throws interprocess_exception
Chris@16:    named_recursive_mutex(create_only_t create_only, const char *name, const permissions &perm = permissions());
Chris@16: 
Chris@16:    //!Opens or creates a global recursive_mutex with a name.
Chris@16:    //!If the recursive_mutex is created, this call is equivalent to
Chris@16:    //!named_recursive_mutex(create_only_t, ... )
Chris@16:    //!If the recursive_mutex is already created, this call is equivalent
Chris@16:    //!named_recursive_mutex(open_only_t, ... )
Chris@16:    //!Does not throw
Chris@16:    named_recursive_mutex(open_or_create_t open_or_create, const char *name, const permissions &perm = permissions());
Chris@16: 
Chris@16:    //!Opens a global recursive_mutex with a name if that recursive_mutex is previously
Chris@16:    //!created. If it is not previously created this function throws
Chris@16:    //!interprocess_exception.
Chris@16:    named_recursive_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:    ~named_recursive_mutex();
Chris@16: 
Chris@16:    //!Unlocks a previously locked
Chris@16:    //!named_recursive_mutex.
Chris@16:    void unlock();
Chris@16: 
Chris@16:    //!Locks named_recursive_mutex, sleeps when named_recursive_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 named_recursive_mutex, returns false when named_recursive_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 named_recursive_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 recursive mutex
Chris@16:    //!from the system
Chris@16:    static bool remove(const char *name);
Chris@16: 
Chris@101:    #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
Chris@16:    private:
Chris@16:    friend class ipcdetail::interprocess_tester;
Chris@16:    void dont_close_on_destruction();
Chris@16: 
Chris@16:    #if defined(BOOST_INTERPROCESS_USE_WINDOWS)
Chris@16:       typedef ipcdetail::windows_named_recursive_mutex   impl_t;
Chris@16:       #undef BOOST_INTERPROCESS_USE_WINDOWS
Chris@16:    #else
Chris@16:       typedef ipcdetail::shm_named_recursive_mutex impl_t;
Chris@16:    #endif
Chris@16:    impl_t m_mut;
Chris@16: 
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 named_recursive_mutex::~named_recursive_mutex()
Chris@16: {}
Chris@16: 
Chris@16: inline void named_recursive_mutex::dont_close_on_destruction()
Chris@16: {  ipcdetail::interprocess_tester::dont_close_on_destruction(m_mut);  }
Chris@16: 
Chris@16: inline named_recursive_mutex::named_recursive_mutex(create_only_t, const char *name, const permissions &perm)
Chris@16:    :  m_mut  (create_only, name, perm)
Chris@16: {}
Chris@16: 
Chris@16: inline named_recursive_mutex::named_recursive_mutex(open_or_create_t, const char *name, const permissions &perm)
Chris@16:    :  m_mut  (open_or_create, name, perm)
Chris@16: {}
Chris@16: 
Chris@16: inline named_recursive_mutex::named_recursive_mutex(open_only_t, const char *name)
Chris@16:    :  m_mut   (open_only, name)
Chris@16: {}
Chris@16: 
Chris@16: inline void named_recursive_mutex::lock()
Chris@16: {  m_mut.lock();  }
Chris@16: 
Chris@16: inline void named_recursive_mutex::unlock()
Chris@16: {  m_mut.unlock();  }
Chris@16: 
Chris@16: inline bool named_recursive_mutex::try_lock()
Chris@16: {  return m_mut.try_lock();  }
Chris@16: 
Chris@16: inline bool named_recursive_mutex::timed_lock(const boost::posix_time::ptime &abs_time)
Chris@101: {  return m_mut.timed_lock(abs_time);  }
Chris@16: 
Chris@16: inline bool named_recursive_mutex::remove(const char *name)
Chris@16: {  return impl_t::remove(name); }
Chris@16: 
Chris@101: #endif   //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
Chris@16: 
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_NAMED_RECURSIVE_MUTEX_HPP