Add new entry in Release_Notes.

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

diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp
index a6a7f08..57f6443 100644 (file)
--- a/include/simgrid/s4u/Comm.hpp
+++ b/include/simgrid/s4u/Comm.hpp
@@ -43,8 +43,6 @@ class XBT_PUBLIC Comm : public Activity_T<Comm> {
   xbt::signal<void(Comm const&)> on_this_send;
   static xbt::signal<void(Comm const&)> on_recv;
   xbt::signal<void(Comm const&)> on_this_recv;
-  inline static xbt::signal<void(Comm const&)> on_start;
-  xbt::signal<void(Comm const&)> on_this_start;
 
 protected:
   void fire_on_completion() const override {
@@ -54,15 +52,12 @@ protected:
   }
   void fire_on_this_completion() const override {
     /* The completion signal of a Comm has to be thrown only once and not by the sender AND the receiver.
-       then Comm::on_completion is thrown in the kernel in CommImpl::finish.
+       then Comm::on_this_completion is thrown in the kernel in CommImpl::finish.
      */
   }
-  void fire_on_suspend() const override { on_suspend(*this); }
-  void fire_on_this_suspend() const override { on_this_suspend(*this); }
-  void fire_on_resume() const override { on_resume(*this); }
-  void fire_on_this_resume() const override { on_this_resume(*this); }
-  void fire_on_veto() const override { on_veto(const_cast<Comm&>(*this)); }
-  void fire_on_this_veto() const override { on_this_veto(const_cast<Comm&>(*this)); }
+  /* These ensure that the on_completion signals are really thrown */
+  void fire_on_completion_for_real() const { Activity_T<Comm>::fire_on_completion(); }
+  void fire_on_this_completion_for_real() const { Activity_T<Comm>::fire_on_this_completion(); }
 
 public:
   /*! \static Add a callback fired when the send of any Comm is posted  */
@@ -73,15 +68,11 @@ public:
   static void on_recv_cb(const std::function<void(Comm const&)>& cb) { on_recv.connect(cb); }
   /*! Add a callback fired when the recv of this specific Comm is posted  */
   void on_this_recv_cb(const std::function<void(Comm const&)>& cb) { on_this_recv.connect(cb); }
-  /*! \static Add a callback fired when any Comm starts  */
-  static void on_start_cb(const std::function<void(Comm const&)>& cb) { on_start.connect(cb); }
-  /*!  Add a callback fired when this specific Comm starts  */
-  void on_this_start_cb(const std::function<void(Comm const&)>& cb) { on_this_start.connect(cb); }
 
   CommPtr set_copy_data_callback(const std::function<void(kernel::activity::CommImpl*, void*, size_t)>& callback);
-  XBT_ATTRIB_DEPRECATED_v337("Please manifest if you actually need this function") static void copy_buffer_callback(
+  XBT_ATTRIB_DEPRECATED_v338("Please manifest if you actually need this function") static void copy_buffer_callback(
       kernel::activity::CommImpl*, void*, size_t);
-  XBT_ATTRIB_DEPRECATED_v337("Please manifest if you actually need this function") static void copy_pointer_callback(
+  XBT_ATTRIB_DEPRECATED_v338("Please manifest if you actually need this function") static void copy_pointer_callback(
       kernel::activity::CommImpl*, void*, size_t);
 
   ~Comm() override;
@@ -160,6 +151,9 @@ public:
   void* get_dst_data() const { return dst_buff_; }
   /** Retrieve the size of the received data. Not to be mixed with @ref Activity::get_remaining()  */
   size_t get_dst_data_size() const { return dst_buff_size_; }
+  /** Retrieve the payload associated to the communication. You can only do that once the comm is (gracefully)
+   * terminated, and it is only setup by the default copy_data callback (not the SMPI one) */
+  void* get_payload() const;
 
   /* Common functions */
 
@@ -190,20 +184,18 @@ public:
 
   Comm* wait_for(double timeout) override;
 
-  /*! \static take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
-  static ssize_t test_any(const std::vector<CommPtr>& comms);
+#ifndef DOXYGEN
+  XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static ssize_t wait_any(const std::vector<CommPtr>& comms) { return deprecated_wait_any_for(comms, -1); }
+  XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static ssize_t wait_any_for(const std::vector<CommPtr>& comms, double timeout) { return deprecated_wait_any_for(comms, timeout); }
 
-  /*! \static take a vector s4u::CommPtr and return when one of them is finished.
-   * The return value is the rank of the first finished CommPtr. */
-  static ssize_t wait_any(const std::vector<CommPtr>& comms) { return wait_any_for(comms, -1); }
-  /*! \static Same as wait_any, but with a timeout. Return -1 if the timeout occurs.*/
-  static ssize_t wait_any_for(const std::vector<CommPtr>& comms, double timeout);
+  static ssize_t deprecated_wait_any_for(const std::vector<CommPtr>& comms,
+                                         double timeout); // XBT_ATTRIB_DEPRECATED_v339
 
-  /*! \static take a vector s4u::CommPtr and return when all of them is finished. */
-  static void wait_all(const std::vector<CommPtr>& comms);
-  /*! \static Same as wait_all, but with a timeout. Return the number of terminated comm (less than comms.size() if
-   *  the timeout occurs). */
-  static size_t wait_all_for(const std::vector<CommPtr>& comms, double timeout);
+  XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static ssize_t test_any(const std::vector<CommPtr>& comms);
+  XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static void wait_all(const std::vector<CommPtr>& comms);
+  XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static size_t
+      wait_all_for(const std::vector<CommPtr>& comms, double timeout);
+#endif
 };
 } // namespace simgrid::s4u