Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
TESH: msg to s4u - act 1
[simgrid.git] / include / simgrid / s4u / Mutex.hpp
index 0b3ebc8..a0f8c0c 100644 (file)
@@ -20,6 +20,7 @@ namespace s4u {
 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
  * [std::mutex](http://en.cppreference.com/w/cpp/thread/mutex)
@@ -28,10 +29,12 @@ class ConditionVariable;
  * Instead, you should use the present class, that is a drop-in replacement of
  * [std::mutex](http://en.cppreference.com/w/cpp/thread/mutex).
  *
+ * As for any S4U object, Mutexes are using the @ref "RAII idiom" s4u_raii 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 ConditionVariable;
   friend simgrid::simix::Mutex;
   simgrid::simix::Mutex* mutex_;
   Mutex(simgrid::simix::Mutex* mutex) : mutex_(mutex) {}
@@ -59,7 +62,6 @@ public:
   /** Constructs a new mutex */
   static Ptr createMutex();
 
-public:
   void lock();
   void unlock();
   bool try_lock();