Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
doc: add a link from Mailbox::get_init to Comm::set_dst_data
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Mon, 21 Feb 2022 23:29:44 +0000 (00:29 +0100)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Mon, 21 Feb 2022 23:29:44 +0000 (00:29 +0100)
include/simgrid/s4u/Activity.hpp
include/simgrid/s4u/Mailbox.hpp

index efba3e2..ff9fd78 100644 (file)
@@ -140,12 +140,12 @@ public:
    * This function is optional: you can call wait() even if you didn't call start()
    */
   virtual Activity* start() = 0;
-  /** Blocks the current actor until the activity is terminated */
   /** Tests whether the given activity is terminated yet. */
   virtual bool test();
   /*! take a vector s4u::ActivityPtr and return the rank of the first finished one (or -1 if none is done). */
   static ssize_t test_any(const std::vector<ActivityPtr>& activities);
 
+  /** Blocks the current actor until the activity is terminated */
   Activity* wait() { return wait_for(-1.0); }
   /** Blocks the current actor until the activity is terminated, or until the timeout is elapsed\n
    *  Raises: timeout exception.*/
index 196c19e..3070b0a 100644 (file)
@@ -110,7 +110,8 @@ public:
   /** Blocking data transmission with timeout */
   void put(void* payload, uint64_t simulated_size_in_bytes, double timeout);
 
-  /** Creates (but don't start) a data reception onto that mailbox */
+  /** Creates (but don't start) a data reception onto that mailbox. 
+   * @verbatim embed:rst:inline You probably want to use :cpp:func:`simgrid::s4u::Comm::set_dst_data` and friends before starting that activity. @endverbatim  */
   CommPtr get_init();
   /** Creates and start an async data reception to that mailbox */
   template <typename T> CommPtr get_async(T** data);