Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
rename the S4U method retrieving the internal impl to getImpl
[simgrid.git] / include / simgrid / s4u / mailbox.hpp
index 93dad67..88f9b98 100644 (file)
@@ -6,16 +6,18 @@
 #ifndef SIMGRID_S4U_MAILBOX_HPP
 #define SIMGRID_S4U_MAILBOX_HPP
 
-#include <boost/unordered_map.hpp>
+#include <string>
+
+#include <boost/intrusive_ptr.hpp>
 
 #include <xbt/base.h>
+
+#include <simgrid/s4u/forward.hpp>
 #include <simgrid/s4u/actor.hpp>
 
 namespace simgrid {
 namespace s4u {
 
-class Comm;
-
 /** @brief Mailboxes
  *
  * Rendez-vous point for network communications, similar to URLs on which you could post and retrieve data.
@@ -24,27 +26,51 @@ class Comm;
  * sender and receiver.
  */
 XBT_PUBLIC_CLASS Mailbox {
-       friend Comm;
+  friend Comm;
+  friend simgrid::s4u::Engine;
+  friend simgrid::simix::Mailbox;
+
+  smx_mailbox_t pimpl_;
+
+  Mailbox(smx_mailbox_t mbox): pimpl_(mbox) {}
 
-private:
-       Mailbox(const char*name, smx_rdv_t inferior);
-public:
-       ~Mailbox();
-       
 protected:
-       smx_rdv_t getInferior() { return p_inferior; }
+  smx_mailbox_t getImpl() { return pimpl_; }
 
 public:
-       /** Get the name of that mailbox */
-       const char *getName();
-       /** Retrieve the mailbox associated to the given string */
-       static Mailbox *byName(const char *name);
-
-private:
-       std::string p_name;
-       smx_rdv_t p_inferior;
-       static boost::unordered_map<std::string, Mailbox *> *mailboxes;
+
+  // We don't have to manage the lifetime of mailboxes:
+  friend void intrusive_ptr_add_ref(Mailbox*) {}
+  friend void intrusive_ptr_release(Mailbox*) {}
+  using Ptr = boost::intrusive_ptr<Mailbox>;
+
+  /** Get the name of that mailbox */
+  const char *getName();
+
+  /** Retrieve the mailbox associated to the given string */
+  static Ptr byName(const char *name);
+
+  /** Returns whether the mailbox contains queued communications */
+  bool empty();
+
+  /** Declare that the specified process is a permanent receiver on that mailbox
+   *
+   * It means that the communications sent to this mailbox will start flowing to its host even before he does a recv().
+   * This models the real behavior of TCP and MPI communications, amongst other.
+   */
+  void setReceiver(Actor* process);
+
+  /** Return the process declared as permanent receiver, or nullptr if none **/
+  ActorPtr receiver();
 };
+
+using MailboxPtr = Mailbox::Ptr;
+
 }} // namespace simgrid::s4u
 
+XBT_PUBLIC(sg_mbox_t) sg_mbox_by_name(const char*name);
+XBT_PUBLIC(int) sg_mbox_is_empty(sg_mbox_t mbox);
+XBT_PUBLIC(void)sg_mbox_setReceiver(sg_mbox_t mbox, smx_process_t process);
+XBT_PUBLIC(smx_process_t) sg_mbox_receiver(sg_mbox_t mbox);
+
 #endif /* SIMGRID_S4U_MAILBOX_HPP */