class ConditionVariable;
+/** @brief A classical mutex, but blocking in the simulation world
+ * @ingroup s4u_api
+ *
+ * It is strictly impossible to use a real mutex, such as
+ * <a href="http://en.cppreference.com/w/cpp/thread/mutex">std::mutex</a>
+ * or <a href="http://pubs.opengroup.org/onlinepubs/007908775/xsh/pthread_mutex_lock.html">pthread_mutex_t</a>,
+ * because it would block the whole simulation.
+ * Instead, you should use the present class, that is a drop-in replacement of
+ * <a href="http://en.cppreference.com/w/cpp/thread/mutex>std::mutex</a>.
+ *
+ * As for any S4U object, Mutexes are using the @ref s4u_raii "RAII idiom" for memory management.
+ * Use createMutex() to get a ::MutexPtr to a newly created mutex and only manipulate ::MutexPtr.
+ *
+ */
XBT_PUBLIC_CLASS Mutex {
-friend ConditionVariable;
-private:
- friend simgrid::simix::Mutex;
- simgrid::simix::Mutex* mutex_;
- Mutex(simgrid::simix::Mutex* mutex) : mutex_(mutex) {}
-public:
+ friend ConditionVariable;
+ friend simgrid::simix::MutexImpl;
+ simgrid::simix::MutexImpl* mutex_;
+ explicit Mutex(simgrid::simix::MutexImpl * mutex) : mutex_(mutex) {}
+ /* refcounting of the intrusive_ptr is delegated to the implementation object */
friend void intrusive_ptr_add_ref(Mutex* mutex)
{
xbt_assert(mutex);
xbt_assert(mutex);
SIMIX_mutex_unref(mutex->mutex_);
}
+public:
using Ptr = boost::intrusive_ptr<Mutex>;
// No copy:
+ /** You cannot create a new mutex by copying an existing one. Use MutexPtr instead */
Mutex(Mutex const&) = delete;
+ /** You cannot create a new mutex by value assignment either. Use MutexPtr instead */
Mutex& operator=(Mutex const&) = delete;
+ /** Constructs a new mutex */
static Ptr createMutex();
-public:
void lock();
void unlock();
bool try_lock();
