#include <boost/interprocess/detail/config_begin.hpp>
#include <boost/interprocess/detail/workaround.hpp>
#include <boost/interprocess/sync/scoped_lock.hpp>
-#include <boost/interprocess/detail/posix_time_types_wrk.hpp>
#include <boost/interprocess/sync/interprocess_mutex.hpp>
#include <boost/interprocess/sync/interprocess_condition.hpp>
#include <climits>
//Exclusive locking
+ //!Requires: The calling thread does not own the mutex.
+ //!
//!Effects: The calling thread tries to obtain exclusive ownership of the mutex,
//! and if another thread has exclusive or sharable ownership of
//! the mutex, it waits until it can obtain the ownership.
//!Throws: interprocess_exception on error.
+ //!
+ //!Note: A program may deadlock if the thread that has ownership calls
+ //! this function. If the implementation can detect the deadlock,
+ //! an exception could be thrown.
void lock();
+ //!Requires: The calling thread does not own the mutex.
+ //!
//!Effects: The calling thread tries to acquire exclusive ownership of the mutex
//! without waiting. If no other thread has exclusive or sharable
//! ownership of the mutex this succeeds.
//!Returns: If it can acquire exclusive ownership immediately returns true.
//! If it has to wait, returns false.
//!Throws: interprocess_exception on error.
+ //!
+ //!Note: A program may deadlock if the thread that has ownership calls
+ //! this function. If the implementation can detect the deadlock,
+ //! an exception could be thrown.
bool try_lock();
+ //!Requires: The calling thread does not own the mutex.
+ //!
//!Effects: The calling thread tries to acquire exclusive ownership of the mutex
//! waiting if necessary until no other thread has exclusive or sharable
//! ownership of the mutex or abs_time is reached.
//!Returns: If acquires exclusive ownership, returns true. Otherwise returns false.
//!Throws: interprocess_exception on error.
- bool timed_lock(const boost::posix_time::ptime &abs_time);
+ //!
+ //!Note: A program may deadlock if the thread that has ownership calls
+ //! this function. If the implementation can detect the deadlock,
+ //! an exception could be thrown.
+ 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)); }
//!Precondition: The thread must have exclusive ownership of the mutex.
//!Effects: The calling thread releases the exclusive ownership of the mutex.
//Sharable locking
+ //!Requires: The calling thread does not own the mutex.
+ //!
//!Effects: The calling thread tries to obtain sharable ownership of the mutex,
//! and if another thread has exclusive ownership of the mutex,
//! waits until it can obtain the ownership.
//!Throws: interprocess_exception on error.
+ //!
+ //!Note: A program may deadlock if the thread that has ownership calls
+ //! this function. If the implementation can detect the deadlock,
+ //! an exception could be thrown.
void lock_sharable();
+ //!Same as `lock_sharable` but with a std-compatible interface
+ //!
+ void lock_shared()
+ { this->lock_sharable(); }
+
+ //!Requires: The calling thread does not own the mutex.
+ //!
//!Effects: The calling thread tries to acquire sharable ownership of the mutex
//! without waiting. If no other thread has exclusive ownership
//! of the mutex this succeeds.
//!Returns: If it can acquire sharable ownership immediately returns true. If it
//! has to wait, returns false.
//!Throws: interprocess_exception on error.
+ //!
+ //!Note: A program may deadlock if the thread that has ownership calls
+ //! this function. If the implementation can detect the deadlock,
+ //! an exception could be thrown.
bool try_lock_sharable();
+ //!Same as `try_lock_sharable` but with a std-compatible interface
+ //!
+ bool try_lock_shared()
+ { return this->try_lock_sharable(); }
+
+ //!Requires: The calling thread does not own the mutex.
+ //!
//!Effects: The calling thread tries to acquire sharable ownership of the mutex
//! waiting if necessary until no other thread has exclusive
//! ownership of the mutex or abs_time is reached.
//!Returns: If acquires sharable ownership, returns true. Otherwise returns false.
//!Throws: interprocess_exception on error.
- bool timed_lock_sharable(const boost::posix_time::ptime &abs_time);
+ //!
+ //!Note: A program may deadlock if the thread that has ownership calls
+ //! this function. If the implementation can detect the deadlock,
+ //! an exception could be thrown.
+ template<class TimePoint>
+ bool timed_lock_sharable(const TimePoint &abs_time);
+
+ //!Same as `timed_lock_sharable`, but this function is modeled after the
+ //!standard library interface.
+ template<class TimePoint> bool try_lock_shared_until(const TimePoint &abs_time)
+ { return this->timed_lock_sharable(abs_time); }
+
+ //!Same as `timed_lock_sharable`, but this function is modeled after the
+ //!standard library interface.
+ template<class Duration> bool try_lock_shared_for(const Duration &dur)
+ { return this->timed_lock_sharable(ipcdetail::duration_to_ustime(dur)); }
//!Precondition: The thread must have sharable ownership of the mutex.
//!Effects: The calling thread releases the sharable ownership of the mutex.
//!Throws: An exception derived from interprocess_exception on error.
void unlock_sharable();
+ //!Same as `unlock_sharable` but with a std-compatible interface
+ //!
+ void unlock_shared()
+ { this->unlock_sharable(); }
+
#if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
private:
typedef scoped_lock<interprocess_mutex> scoped_lock_t;
return true;
}
+template<class TimePoint>
inline bool interprocess_sharable_mutex::timed_lock
- (const boost::posix_time::ptime &abs_time)
+ (const TimePoint &abs_time)
{
scoped_lock_t lck(m_mut, abs_time);
if(!lck.owns()) return false;
return true;
}
+template<class TimePoint>
inline bool interprocess_sharable_mutex::timed_lock_sharable
- (const boost::posix_time::ptime &abs_time)
+ (const TimePoint &abs_time)
{
scoped_lock_t lck(m_mut, abs_time);
if(!lck.owns()) return false;
projects / ceph.git / blobdiff