Mark all of simix.h as deprecated.

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

diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp
index c12b8eb..3070b0a 100644 (file)
--- a/include/simgrid/s4u/Mailbox.hpp
+++ b/include/simgrid/s4u/Mailbox.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2022. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -8,9 +8,11 @@
 
 #include <simgrid/forward.h>
 #include <simgrid/s4u/Actor.hpp>
+#include <simgrid/s4u/Comm.hpp>
 #include <smpi/forward.hpp>
 #include <xbt/string.hpp>
 
+#include <memory>
 #include <string>
 
 namespace simgrid {
@@ -18,9 +20,11 @@ namespace s4u {
 
 /** @brief Mailboxes: Network rendez-vous points. */
 class XBT_PUBLIC Mailbox {
+#ifndef DOXYGEN
   friend Comm;
   friend smpi::Request;
   friend kernel::activity::MailboxImpl;
+#endif
 
   kernel::activity::MailboxImpl* const pimpl_;
 
@@ -42,6 +46,9 @@ public:
   /** Returns whether the mailbox contains queued communications */
   bool empty() const;
 
+  /* Returns the number of queued communications */
+  size_t size() const;
+
   /** Check if there is a communication going on in a mailbox. */
   bool listen() const;
 
@@ -79,29 +86,65 @@ public:
 
   /** Creates (but don't start) a data transmission to that mailbox */
   CommPtr put_init();
-  /** Creates (but don't start) a data transmission to that mailbox */
+  /** Creates (but don't start) a data transmission to that mailbox.
+   *
+   * Please note that if you send a pointer to some data, you must ensure that your data remains live during the
+   * communication, or the receiver will get a pointer to a garbled memory area.
+   */
   CommPtr put_init(void* data, uint64_t simulated_size_in_bytes);
-  /** Creates and start a data transmission to that mailbox */
+  /** Creates and start a data transmission to that mailbox.
+   *
+   * Please note that if you send a pointer to some data, you must ensure that your data remains live during the
+   * communication, or the receiver will get a pointer to a garbled memory area.
+   */
   CommPtr put_async(void* data, uint64_t simulated_size_in_bytes);
 
   kernel::activity::ActivityImplPtr iprobe(int type, bool (*match_fun)(void*, void*, kernel::activity::CommImpl*),
                                            void* data);
-  /** Blocking data transmission */
+  /** Blocking data transmission.
+   *
+   * Please note that if you send a pointer to some data, you must ensure that your data remains live during the
+   * communication, or the receiver will get a pointer to a garbled memory area.
+   */
   void put(void* payload, uint64_t simulated_size_in_bytes);
   /** 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 */
-  CommPtr get_async(void** data);
+  template <typename T> CommPtr get_async(T** data);
 
   /** Blocking data reception */
-  void* get(); // FIXME: make a typed template version
+  template <typename T> T* get();
+  template <typename T> std::unique_ptr<T> get_unique() { return std::unique_ptr<T>(get<T>()); }
+
   /** Blocking data reception with timeout */
-  void* get(double timeout);
+  template <typename T> T* get(double timeout);
+  template <typename T> std::unique_ptr<T> get_unique(double timeout) { return std::unique_ptr<T>(get<T>(timeout)); }
 };
 
+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();
+  return res;
+}
+
+template <typename T> T* Mailbox::get()
+{
+  T* res = nullptr;
+  get_async<T>(&res)->wait();
+  return res;
+}
+
+template <typename T> T* Mailbox::get(double timeout)
+{
+  T* res = nullptr;
+  get_async<T>(&res)->wait_for(timeout);
+  return res;
+}
 } // namespace s4u
 } // namespace simgrid