X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/149c63f36e15b8500b1e826bda5138318ff7ba2b..43dc8ea1eae96e9d084aaabeed9beef568a7dea6:/include/simgrid/s4u/Mailbox.hpp

diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp
index 372b730eca..f42bd58038 100644
--- 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-2021. 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 {
@@ -40,16 +42,19 @@ public:
   static Mailbox* by_name(const std::string& name);
 
   /** Returns whether the mailbox contains queued communications */
-  bool empty();
+  bool empty() const;
 
   /** Check if there is a communication going on in a mailbox. */
-  bool listen();
+  bool listen() const;
+
+  /** 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. */
-  bool ready();
+  bool ready() const;
 
   /** Gets the first element in the queue (without dequeuing it), or nullptr if none is there */
-  kernel::activity::CommImplPtr front();
+  kernel::activity::CommImplPtr front() const;
 
   /** Declare that the specified actor is a permanent receiver on that mailbox
    *
@@ -66,13 +71,13 @@ public:
    * Note that being permanent receivers of a mailbox prevents actors to be garbage-collected.
    * If your simulation creates many short-lived actors that marked as permanent receiver, you
    * should call mailbox->set_receiver(nullptr) by the end of the actors so that their memory gets
-   * properly reclaimed. This call should be at the end of the actor's function, not in a on_exit
+   * properly reclaimed. This call should be at the end of the actor's function, not in an on_exit
    * callback.
    */
   void set_receiver(ActorPtr actor);
 
   /** Return the actor declared as permanent receiver, or nullptr if none **/
-  ActorPtr get_receiver();
+  ActorPtr get_receiver() const;
 
   /** Creates (but don't start) a data transmission to that mailbox */
   CommPtr put_init();
@@ -81,7 +86,8 @@ public:
   /** Creates and start a data transmission to that mailbox */
   CommPtr put_async(void* data, uint64_t simulated_size_in_bytes);
 
-  smx_activity_t iprobe(int type, bool (*match_fun)(void*, void*, kernel::activity::CommImpl*), void* data);
+  kernel::activity::ActivityImplPtr iprobe(int type, bool (*match_fun)(void*, void*, kernel::activity::CommImpl*),
+                                           void* data);
   /** Blocking data transmission */
   void put(void* payload, uint64_t simulated_size_in_bytes);
   /** Blocking data transmission with timeout */
@@ -90,14 +96,54 @@ public:
   /** Creates (but don't start) a data reception onto that mailbox */
   CommPtr get_init();
   /** Creates and start an async data reception to that mailbox */
-  CommPtr get_async(void** data);
+  XBT_ATTRIB_DEPRECATED_v331("Please use typed template Mailbox::get_async<>()") 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();
+  XBT_ATTRIB_DEPRECATED_v331("Please use typed template Mailbox::get<>()") void* 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);
+  XBT_ATTRIB_DEPRECATED_v331("Please use typed template Mailbox::get<>()") void* 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;
+}
+
+inline CommPtr Mailbox::get_async(void** data) // XBT_ATTRIB_DEPRECATED_v331
+{
+  return get_async<void>(data);
+}
+inline void* Mailbox::get() // XBT_ATTRIB_DEPRECATED_v331
+{
+  return get<void>();
+}
+inline void* Mailbox::get(double timeout) // XBT_ATTRIB_DEPRECATED_v331
+{
+  return get<void>(timeout);
+}
+
 } // namespace s4u
 } // namespace simgrid