X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/75e8b2ae65722d849ef899616de7091286ec91f5..36fccba5f4f2b4c32e97c4e56911eb5bd804f7c9:/include/simgrid/s4u/Mutex.hpp
diff --git a/include/simgrid/s4u/Mutex.hpp b/include/simgrid/s4u/Mutex.hpp
index c208d7d650..87d47682a2 100644
--- a/include/simgrid/s4u/Mutex.hpp
+++ b/include/simgrid/s4u/Mutex.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
@@ -12,38 +12,42 @@
namespace simgrid {
namespace s4u {
-/** @brief A classical mutex, but blocking in the simulation world
- * @ingroup s4u_api
+/** @brief A classical mutex, but blocking in the simulation world.
*
+ * @beginrst
* It is strictly impossible to use a real mutex, such as
- * std::mutex
- * or pthread_mutex_t,
+ * `std::mutex `_
+ * or `pthread_mutex_t `_,
* because it would block the whole simulation.
- * Instead, you should use the present class, that is a drop-in replacement of
- * std::mutex.
+ * Instead, you should use the present class, that is a drop-in replacement of these mechanisms.
*
- * As for any S4U object, Mutexes are using the @ref s4u_raii "RAII idiom" for memory management.
- * Use create() to get a simgrid::s4u::MutexPtr to a newly created mutex and only manipulate simgrid::s4u::MutexPtr.
+ * An example is available in Section :ref:`s4u_ex_IPC`.
*
+ * As for any S4U object, you can use the :ref:`RAII idiom ` for memory management of Mutexes.
+ * Use :cpp:func:`create() ` to get a :cpp:type:`simgrid::s4u::MutexPtr` to a newly
+ * created mutex, and only manipulate :cpp:type:`simgrid::s4u::MutexPtr`.
+ * @endrst
*/
class XBT_PUBLIC Mutex {
+#ifndef DOXYGEN
friend ConditionVariable;
friend kernel::activity::MutexImpl;
+ friend void kernel::activity::intrusive_ptr_release(kernel::activity::MutexImpl* mutex);
+#endif
kernel::activity::MutexImpl* const pimpl_;
/* refcounting */
friend XBT_PUBLIC void intrusive_ptr_add_ref(const Mutex* mutex);
friend XBT_PUBLIC void intrusive_ptr_release(const Mutex* mutex);
-public:
explicit Mutex(kernel::activity::MutexImpl* mutex) : pimpl_(mutex) {}
- ~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;
+ ~Mutex() = default;
+#ifndef DOXYGEN
+ Mutex(Mutex const&) = delete; // No copy constructor; Use MutexPtr instead
+ Mutex& operator=(Mutex const&) = delete; // No direct assignment either. Use MutexPtr instead
+#endif
+public:
/** Constructs a new mutex */
static MutexPtr create();
void lock();