#include <boost/interprocess/detail/config_begin.hpp>
#include <boost/interprocess/detail/workaround.hpp>
#include <boost/interprocess/creation_tags.hpp>
-#include <boost/interprocess/detail/posix_time_types_wrk.hpp>
#include <boost/interprocess/permissions.hpp>
+
#if !defined(BOOST_INTERPROCESS_FORCE_GENERIC_EMULATION) && defined (BOOST_INTERPROCESS_WINDOWS)
#include <boost/interprocess/sync/windows/named_recursive_mutex.hpp>
- #define BOOST_INTERPROCESS_USE_WINDOWS
+ #define BOOST_INTERPROCESS_NAMED_RECURSIVE_MUTEX_USE_WINAPI
#else
#include <boost/interprocess/sync/shm/named_recursive_mutex.hpp>
#endif
//!Creates a global recursive_mutex with a name.
//!If the recursive_mutex can't be created throws interprocess_exception
- named_recursive_mutex(create_only_t create_only, const char *name, const permissions &perm = permissions());
+ named_recursive_mutex(create_only_t, const char *name, const permissions &perm = permissions());
+
+ //!Opens or creates a global recursive_mutex with a name.
+ //!If the recursive_mutex is created, this call is equivalent to
+ //!named_recursive_mutex(create_only_t, ... )
+ //!If the recursive_mutex is already created, this call is equivalent
+ //!named_recursive_mutex(open_only_t, ... )
+ //!Does not throw
+ named_recursive_mutex(open_or_create_t, const char *name, const permissions &perm = permissions());
+
+ //!Opens a global recursive_mutex with a name if that recursive_mutex is previously
+ //!created. If it is not previously created this function throws
+ //!interprocess_exception.
+ named_recursive_mutex(open_only_t, const char *name);
+
+ #if defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
+
+ //!Creates a global recursive_mutex with a name.
+ //!If the recursive_mutex can't be created throws interprocess_exception
+ //!
+ //!Note: This function is only available on operating systems with
+ //! native wchar_t APIs (e.g. Windows).
+ named_recursive_mutex(create_only_t, const wchar_t *name, const permissions &perm = permissions());
//!Opens or creates a global recursive_mutex with a name.
//!If the recursive_mutex is created, this call is equivalent to
//!If the recursive_mutex is already created, this call is equivalent
//!named_recursive_mutex(open_only_t, ... )
//!Does not throw
- named_recursive_mutex(open_or_create_t open_or_create, const char *name, const permissions &perm = permissions());
+ //!
+ //!Note: This function is only available on operating systems with
+ //! native wchar_t APIs (e.g. Windows).
+ named_recursive_mutex(open_or_create_t, const wchar_t *name, const permissions &perm = permissions());
//!Opens a global recursive_mutex with a name if that recursive_mutex is previously
//!created. If it is not previously created this function throws
//!interprocess_exception.
- named_recursive_mutex(open_only_t open_only, const char *name);
+ //!
+ //!Note: This function is only available on operating systems with
+ //! native wchar_t APIs (e.g. Windows).
+ named_recursive_mutex(open_only_t, const wchar_t *name);
+
+ #endif //defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
//!Destroys *this and indicates that the calling process is finished using
//!the resource. The destructor function will deallocate
//!Locks named_recursive_mutex, sleeps when named_recursive_mutex is already locked.
//!Throws interprocess_exception if a severe error is found.
+ //!
+ //!Note: A program shall not deadlock if the thread that has ownership calls
+ //! this function.
void lock();
//!Tries to lock the named_recursive_mutex, returns false when named_recursive_mutex
//!is already locked, returns true when success.
//!Throws interprocess_exception if a severe error is found.
+ //!
+ //!Note: A program shall not deadlock if the thread that has ownership calls
+ //! this function.
bool try_lock();
//!Tries to lock the named_recursive_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);
+ //!
+ //!Note: A program shall not deadlock if the thread that has ownership calls
+ //! this function.
+ template<class TimePoint>
+ bool timed_lock(const TimePoint &abs_time);
+
+ //!Same as `timed_lock`, but this function is modeled after the
+ //!standard library interface.
+ template<class TimePoint> bool try_lock_until(const TimePoint &abs_time)
+ { return this->timed_lock(abs_time); }
+
+ //!Same as `timed_lock`, but this function is modeled after the
+ //!standard library interface.
+ template<class Duration> bool try_lock_for(const Duration &dur)
+ { return this->timed_lock(ipcdetail::duration_to_ustime(dur)); }
//!Erases a named recursive mutex
//!from the system
static bool remove(const char *name);
+ #if defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
+ //!Erases a named recursive mutex
+ //!from the system
+ //!
+ //!Note: This function is only available on operating systems with
+ //! native wchar_t APIs (e.g. Windows).
+ static bool remove(const wchar_t *name);
+ #endif //defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
+
#if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
private:
friend class ipcdetail::interprocess_tester;
void dont_close_on_destruction();
- #if defined(BOOST_INTERPROCESS_USE_WINDOWS)
- typedef ipcdetail::windows_named_recursive_mutex impl_t;
- #undef BOOST_INTERPROCESS_USE_WINDOWS
+ #if defined(BOOST_INTERPROCESS_NAMED_RECURSIVE_MUTEX_USE_WINAPI)
+ typedef ipcdetail::winapi_named_recursive_mutex impl_t;
#else
typedef ipcdetail::shm_named_recursive_mutex impl_t;
#endif
: m_mut (open_only, name)
{}
+#if defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
+
+inline named_recursive_mutex::named_recursive_mutex(create_only_t, const wchar_t *name, const permissions &perm)
+ : m_mut (create_only, name, perm)
+{}
+
+inline named_recursive_mutex::named_recursive_mutex(open_or_create_t, const wchar_t *name, const permissions &perm)
+ : m_mut (open_or_create, name, perm)
+{}
+
+inline named_recursive_mutex::named_recursive_mutex(open_only_t, const wchar_t *name)
+ : m_mut (open_only, name)
+{}
+
+#endif //defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
+
inline void named_recursive_mutex::lock()
{ m_mut.lock(); }
inline bool named_recursive_mutex::try_lock()
{ return m_mut.try_lock(); }
-inline bool named_recursive_mutex::timed_lock(const boost::posix_time::ptime &abs_time)
+template<class TimePoint>
+inline bool named_recursive_mutex::timed_lock(const TimePoint &abs_time)
{ return m_mut.timed_lock(abs_time); }
inline bool named_recursive_mutex::remove(const char *name)
{ return impl_t::remove(name); }
+#if defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
+
+inline bool named_recursive_mutex::remove(const wchar_t *name)
+{ return impl_t::remove(name); }
+
+#endif //defined(BOOST_INTERPROCESS_WCHAR_NAMED_RESOURCES) || defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
+
#endif //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
} //namespace interprocess {
projects / ceph.git / blobdiff