Kill unstandard, untested and dubious ways to use ConditionVariables

[simgrid.git] / include / simgrid / s4u / ConditionVariable.hpp

diff --git a/include/simgrid/s4u/ConditionVariable.hpp b/include/simgrid/s4u/ConditionVariable.hpp
index 7b0cab0..448b4a8 100644 (file)
--- a/include/simgrid/s4u/ConditionVariable.hpp
+++ b/include/simgrid/s4u/ConditionVariable.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2023. 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. */
@@ -9,15 +9,15 @@
 #include <simgrid/forward.h>
 
 #include <simgrid/chrono.hpp>
+#include <simgrid/s4u/Engine.hpp>
 #include <simgrid/s4u/Mutex.hpp>
 
 #include <future>
 
-namespace simgrid {
-namespace s4u {
+namespace simgrid::s4u {
 
 /**
- * @rst
+ * @beginrst
  * SimGrid's condition variables are meant to be drop-in replacements of ``std::condition_variable``.
  * Please refer to the `documentation of standard C++ <https://en.cppreference.com/w/cpp/thread/condition_variable>`_
  * for more information on condition variables. A SimGrid example is available in Section :ref:`s4u_ex_IPC`.
@@ -25,13 +25,16 @@ namespace s4u {
  */
 class XBT_PUBLIC ConditionVariable {
 private:
+#ifndef DOXYGEN
   friend kernel::activity::ConditionVariableImpl;
-  kernel::activity::ConditionVariableImpl* const cond_;
+  friend XBT_PUBLIC void kernel::activity::intrusive_ptr_release(kernel::activity::ConditionVariableImpl* cond);
+#endif
 
-public:
-#ifndef DOXYGEN
-  explicit ConditionVariable(kernel::activity::ConditionVariableImpl* cond) : cond_(cond) {}
+  kernel::activity::ConditionVariableImpl* const pimpl_;
 
+  explicit ConditionVariable(kernel::activity::ConditionVariableImpl* cond) : pimpl_(cond) {}
+  ~ConditionVariable() = default;
+#ifndef DOXYGEN
   ConditionVariable(ConditionVariable const&) = delete;
   ConditionVariable& operator=(ConditionVariable const&) = delete;
 
@@ -39,9 +42,10 @@ public:
   friend XBT_PUBLIC void intrusive_ptr_release(const ConditionVariable* cond);
 #endif
 
-  /** Create a new condition variable and return a smart pointer
+public:
+  /** \static Create a new condition variable and return a smart pointer
    *
-   * @rst
+   * @beginrst
    * You should only manipulate :cpp:type:`simgrid::s4u::ConditionVariablePtr`, as created by this function (see also :ref:`s4u_raii`).
    * @endrst
    */
@@ -61,29 +65,9 @@ public:
   std::cv_status wait_until(const std::unique_lock<s4u::Mutex>& lock, double timeout_time);
   /// Wait for the given amount of seconds (specified as a plain double)
   std::cv_status wait_for(const std::unique_lock<s4u::Mutex>& lock, double duration);
-  /// Wait until predicate is true, or the given instant (specified as a plain double)
-  template <class P> bool wait_until(const std::unique_lock<s4u::Mutex>& lock, double timeout_time, P pred)
-  {
-    while (not pred())
-      if (this->wait_until(lock, timeout_time) == std::cv_status::timeout)
-        return pred();
-    return true;
-  }
-  /// As long as the predicate is false, wait for the given amount of seconds (specified as a plain double)
-  template <class P> bool wait_for(const std::unique_lock<s4u::Mutex>& lock, double duration, P pred)
-  {
-    return this->wait_until(lock, SIMIX_get_clock() + duration, std::move(pred));
-  }
 
   // Wait function taking a C++ style time:
 
-  /// As long as the predicate is false, wait for the given amount of seconds (specified in C++ style)
-  template <class Rep, class Period, class P>
-  bool wait_for(const std::unique_lock<s4u::Mutex>& lock, std::chrono::duration<Rep, Period> duration, P pred)
-  {
-    auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
-    return this->wait_for(lock, seconds.count(), pred);
-  }
   /// Wait for the given amount of seconds (specified in C++ style)
   template <class Rep, class Period>
   std::cv_status wait_for(const std::unique_lock<s4u::Mutex>& lock, std::chrono::duration<Rep, Period> duration)
@@ -98,13 +82,6 @@ public:
     auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
     return this->wait_until(lock, timeout_native.time_since_epoch().count());
   }
-  /** Wait until predicate is true, or the given instant (specified in C++ style) */
-  template <class Duration, class P>
-  bool wait_until(const std::unique_lock<s4u::Mutex>& lock, const SimulationTimePoint<Duration>& timeout_time, P pred)
-  {
-    auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
-    return this->wait_until(lock, timeout_native.time_since_epoch().count(), std::move(pred));
-  }
 
   /** Unblock one actor blocked on that condition variable. If none was blocked, nothing happens. */
   void notify_one();
@@ -112,7 +89,6 @@ public:
   void notify_all();
 };
 
-} // namespace s4u
-} // namespace simgrid
+} // namespace simgrid::s4u
 
 #endif