docs: present asynchronous activities

[simgrid.git] / examples / s4u / async-waitall / s4u-async-waitall.cpp

diff --git a/examples/s4u/async-waitall/s4u-async-waitall.cpp b/examples/s4u/async-waitall/s4u-async-waitall.cpp
index 6ac940d..514c69e 100644 (file)
--- a/examples/s4u/async-waitall/s4u-async-waitall.cpp
+++ b/examples/s4u/async-waitall/s4u-async-waitall.cpp
@@ -34,37 +34,42 @@ public:
   }
   void operator()()
   {
+    // sphinx-doc: init-begin (this line helps the doc to build; ignore it)
+    /* Vector in which we store all ongoing communications */
     std::vector<simgrid::s4u::CommPtr> pending_comms;
 
+    /* Make a vector of the mailboxes to use */
+    std::vector<simgrid::s4u::MailboxPtr> mboxes;
+    for (int i = 0; i < receivers_count; i++)
+      mboxes.push_back(simgrid::s4u::Mailbox::by_name(std::string("receiver-") + std::to_string(i)));
+    // sphinx-doc: init-end
+
     /* Start dispatching all messages to receivers, in a round robin fashion */
     for (int i = 0; i < messages_count; i++) {
 
-      std::string mboxName          = std::string("receiver-") + std::to_string(i % receivers_count);
-      simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(mboxName);
-      std::string msgName           = std::string("Message ") + std::to_string(i);
-      std::string* payload          = new std::string(msgName); // copy the data we send:
-                                                                // 'msgName' is not a stable storage location
-      XBT_INFO("Send '%s' to '%s'", msgName.c_str(), mboxName.c_str());
-      /* Create a communication representing the ongoing communication */
-      simgrid::s4u::CommPtr comm = mbox->put_async(payload, msg_size);
-      /* Add this comm to the vector of all known comms */
+      std::string msg_content = std::string("Message ") + std::to_string(i);
+      // Copy the data we send: 'msg_content' is not a stable storage location.
+      // It will be destroyed when this actor leaves the loop, ie before the receiver gets it
+      std::string* payload = new std::string(msg_content);
+
+      XBT_INFO("Send '%s' to '%s'", msg_content.c_str(), mboxes[i % receivers_count]->get_cname());
+
+      /* Create a communication representing the ongoing communication, and store it in pending_comms */
+      simgrid::s4u::CommPtr comm = mboxes[i % receivers_count]->put_async(payload, msg_size);
       pending_comms.push_back(comm);
     }
 
-    /* Start sending messages to let the workers know that they should stop */
+    /* Start sending messages to let the workers know that they should stop */ // sphinx-doc: send-begin
     for (int i = 0; i < receivers_count; i++) {
-      std::string mboxName          = std::string("receiver-") + std::to_string(i % receivers_count);
-      simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(mboxName);
-      std::string* payload          = new std::string("finalize"); // Make a copy of the data we will send
-
-      simgrid::s4u::CommPtr comm = mbox->put_async(payload, 0);
+      XBT_INFO("Send 'finalize' to 'receiver-%d'", i);
+      simgrid::s4u::CommPtr comm = mboxes[i]->put_async(new std::string("finalize"), 0);
       pending_comms.push_back(comm);
-      XBT_INFO("Send 'finalize' to 'receiver-%ld'", i % receivers_count);
     }
     XBT_INFO("Done dispatching all messages");
 
     /* Now that all message exchanges were initiated, wait for their completion in one single call */
     simgrid::s4u::Comm::wait_all(&pending_comms);
+    // sphinx-doc: send-end
 
     XBT_INFO("Goodbye now!");
   }