fix some errors and warnings in the doc generation

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

diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp
index cdcd9f0..467dd88 100644 (file)
--- a/include/simgrid/s4u/Comm.hpp
+++ b/include/simgrid/s4u/Comm.hpp
@@ -10,6 +10,7 @@
 #include <simgrid/s4u/Activity.hpp>
 
 #include <atomic>
+#include <string>
 #include <vector>
 
 namespace simgrid {
@@ -27,10 +28,10 @@ class XBT_PUBLIC Comm : public Activity {
   size_t dst_buff_size_               = 0;
   void* src_buff_                     = nullptr;
   size_t src_buff_size_               = sizeof(void*);
+  std::string tracing_category_       = "";
   std::atomic_int_fast32_t refcount_{0};
-
   /* FIXME: expose these elements in the API */
-  int detached_                                                           = 0;
+  bool detached_                                                          = false;
   int (*match_fun_)(void*, void*, kernel::activity::CommImpl*)            = nullptr;
   void (*clean_fun_)(void*)                                               = nullptr;
   void (*copy_data_function_)(kernel::activity::CommImpl*, void*, size_t) = nullptr;
@@ -38,15 +39,17 @@ class XBT_PUBLIC Comm : public Activity {
   Comm() : Activity() {}
 
 public:
-  friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Comm * c);
-  friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Comm * c);
-  friend simgrid::s4u::Mailbox; // Factory of comms
+#ifndef DOXYGEN
+  friend XBT_PUBLIC void intrusive_ptr_release(Comm* c);
+  friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm* c);
+  friend Mailbox; // Factory of comms
+#endif
 
   virtual ~Comm();
 
-  static xbt::signal<void(ActorPtr)> on_sender_start;
-  static xbt::signal<void(ActorPtr)> on_receiver_start;
-  static xbt::signal<void(ActorPtr)> on_completion;
+  static xbt::signal<void(Actor const&)> on_sender_start;
+  static xbt::signal<void(Actor const&)> on_receiver_start;
+  static xbt::signal<void(Actor const&)> on_completion;
 
   /*! take a vector s4u::CommPtr and return when one of them is finished.
    * The return value is the rank of the first finished CommPtr. */
@@ -111,44 +114,17 @@ public:
    * That's a buffer where the sent data will be copied  */
   CommPtr set_dst_data(void** buff, size_t size);
 
+  CommPtr set_tracing_category(const std::string& category);
+
   /** Retrieve the mailbox on which this comm acts */
   Mailbox* get_mailbox();
   /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining()  */
   size_t get_dst_data_size();
 
-  s4u::ActorPtr get_sender();
+  Actor* get_sender();
 
 #ifndef DOXYGEN
   XBT_ATTRIB_DEPRECATED_v324("Please use Comm::wait_for()") void wait(double t) override { wait_for(t); }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_rate()") Activity* setRate(double rate)
-  {
-    return set_rate(rate).get();
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff)
-  {
-    return set_src_data(buff).get();
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size)
-  {
-    return set_src_data(buff, size).get();
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size)
-  {
-    return set_src_data_size(size).get();
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff)
-  {
-    return set_dst_data(buff).get();
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size)
-  {
-    return set_dst_data(buff, size).get();
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize()
-  {
-    return get_dst_data_size();
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") Mailbox* getMailbox() { return get_mailbox(); }
 #endif
 };
 } // namespace s4u