added ns3 wifi doc

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

diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp
index 2ce888a..f60c070 100644 (file)
--- a/include/simgrid/s4u/Mailbox.hpp
+++ b/include/simgrid/s4u/Mailbox.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2020. 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. */
@@ -6,8 +6,10 @@
 #ifndef SIMGRID_S4U_MAILBOX_HPP
 #define SIMGRID_S4U_MAILBOX_HPP
 
-#include <xbt/string.hpp>
+#include <simgrid/forward.h>
 #include <simgrid/s4u/Actor.hpp>
+#include <smpi/forward.hpp>
+#include <xbt/string.hpp>
 
 #include <string>
 
@@ -17,6 +19,7 @@ namespace s4u {
 /** @brief Mailboxes: Network rendez-vous points. */
 class XBT_PUBLIC Mailbox {
   friend Comm;
+  friend smpi::Request;
   friend kernel::activity::MailboxImpl;
 
   kernel::activity::MailboxImpl* const pimpl_;
@@ -24,16 +27,16 @@ class XBT_PUBLIC Mailbox {
   explicit Mailbox(kernel::activity::MailboxImpl * mbox) : pimpl_(mbox) {}
   ~Mailbox() = default;
 
-public:
-  /** private function, do not use. FIXME: make me protected */
-  kernel::activity::MailboxImpl* get_impl() { return pimpl_; }
+protected:
+  kernel::activity::MailboxImpl* get_impl() const { return pimpl_; }
 
+public:
   /** @brief Retrieves the name of that mailbox as a C++ string */
   const xbt::string& get_name() const;
   /** @brief Retrieves the name of that mailbox as a C string */
   const char* get_cname() const;
 
-  /** Retrieve the mailbox associated to the given name */
+  /** Retrieve the mailbox associated to the given name. Mailboxes are created on demand. */
   static Mailbox* by_name(const std::string& name);
 
   /** Returns whether the mailbox contains queued communications */
@@ -42,6 +45,9 @@ public:
   /** Check if there is a communication going on in a mailbox. */
   bool listen();
 
+  /** Look if there is a communication going on in a mailbox and return the PID of the sender actor */
+  aid_t listen_from();
+
   /** Check if there is a communication ready to be consumed from a mailbox. */
   bool ready();
 
@@ -78,7 +84,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, int (*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 */
@@ -93,36 +100,6 @@ public:
   void* get(); // FIXME: make a typed template version
   /** Blocking data reception with timeout */
   void* get(double timeout);
-
-  // Deprecated functions
-#ifndef DOXYGEN
-  /** @deprecated Mailbox::set_receiver() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::set_receiver()") void setReceiver(ActorPtr actor)
-  {
-    set_receiver(actor);
-  }
-  /** @deprecated Mailbox::get_receiver() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_receiver()") ActorPtr getReceiver() { return get_receiver(); }
-  /** @deprecated Mailbox::get_name() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_name()") const xbt::string& getName() const { return get_name(); }
-  /** @deprecated Mailbox::get_cname() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_cname()") const char* getCname() const { return get_cname(); }
-  /** @deprecated Mailbox::get_impl() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_impl()") kernel::activity::MailboxImpl* getImpl()
-  {
-    return get_impl();
-  }
-  /** @deprecated Mailbox::by_name() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static Mailbox* byName(const char* name)
-  {
-    return by_name(name);
-  }
-  /** @deprecated Mailbox::by_name() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static Mailbox* byName(const std::string& name)
-  {
-    return by_name(name);
-  }
-#endif
 };
 
 } // namespace s4u