Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add accessors
[simgrid.git] / include / simgrid / s4u / Mailbox.hpp
index 84db62a2b32216e917b1e652887ef9ee457269a3..d3bec3587dcf59d434594eb6ab944efbef14aa1d 100644 (file)
@@ -14,8 +14,7 @@
 #include <memory>
 #include <string>
 
-namespace simgrid {
-namespace s4u {
+namespace simgrid::s4u {
 
 /** @brief Mailboxes: Network rendez-vous points. */
 class XBT_PUBLIC Mailbox {
@@ -54,7 +53,11 @@ public:
   /** Look if there is a communication going on in a mailbox and return the PID of the sender actor */
   aid_t listen_from() const;
 
-  /** Check if there is a communication ready to be consumed from a mailbox. */
+  /** Check if there is a communication ready to be consumed from a mailbox.
+   * \beginrst
+   *  See :ref:`this example <s4u_ex_mailbox_ready>`.
+   * \endrst
+   */
   bool ready() const;
 
   /** Gets the first element in the queue (without dequeuing it), or nullptr if none is there */
@@ -130,7 +133,7 @@ public:
 template <typename T> CommPtr Mailbox::get_async(T** data)
 {
   CommPtr res = get_init()->set_dst_data(reinterpret_cast<void**>(data), sizeof(void*));
-  res->vetoable_start();
+  res->start();
   return res;
 }
 
@@ -147,7 +150,6 @@ template <typename T> T* Mailbox::get(double timeout)
   get_async<T>(&res)->wait_for(timeout);
   return res;
 }
-} // namespace s4u
-} // namespace simgrid
+} // namespace simgrid::s4u
 
 #endif /* SIMGRID_S4U_MAILBOX_HPP */