fix: Deprecate broken API

Signed-off-by: Janosch Machowinski <[email protected]>
ros2 · Dec 2, 2024 · 7cd8101 · 7cd8101
1 parent a1f5ae7
commit 7cd8101
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/rclcpp/include/rclcpp/clock.hpp b/rclcpp/include/rclcpp/clock.hpp
@@ -194,12 +194,17 @@ class Clock
   ros_time_is_active();
 
   /**
+   * Deprecated. This API is broken, as there is no way to get a deep
+   * copy of a clock. Therefore one can experience spurious wakeups triggered
+   * by some other instance of a clock.
+   *
    * Cancels an ongoing or future sleep operation of one thread.
    *
    * This function can be used by one thread, to wakeup another thread that is
    * blocked using any of the sleep_ or wait_ methods of this class.
    */
   RCLCPP_PUBLIC
+  [[deprecated("Use ClockConditionalVariable")]]
   void
   cancel_sleep_or_wait();