#ifndef SIMGRID_S4U_MAILBOX_HPP
#define SIMGRID_S4U_MAILBOX_HPP
-#include <boost/unordered_map.hpp>
+#include <string>
-#include "simgrid/s4u/process.hpp"
+#include <xbt/base.h>
+
+#include <simgrid/s4u/forward.hpp>
+#include <simgrid/s4u/Actor.hpp>
namespace simgrid {
namespace s4u {
* You can access any mailbox without any latency. The network delay are only related to the location of the
* sender and receiver.
*/
-class Mailbox {
- friend Process;
+XBT_PUBLIC_CLASS Mailbox {
+ friend Comm;
+ friend simgrid::s4u::Engine;
+ friend simgrid::simix::Mailbox;
-private:
- Mailbox(const char*name, smx_rdv_t inferior);
-public:
- ~Mailbox();
-
-protected:
- smx_rdv_t getInferior() { return p_inferior; }
+ simgrid::simix::Mailbox *pimpl_;
+
+ Mailbox(smx_mailbox_t mbox): pimpl_(mbox) {}
+ // We don't have to manage the lifetime of mailboxes:
+ friend void intrusive_ptr_add_ref(Mailbox*) {}
+ friend void intrusive_ptr_release(Mailbox*) {}
public:
- /** Retrieve the mailbox associated to the given string */
- static Mailbox *byName(const char *name);
+ smx_mailbox_t getImpl() { return pimpl_; } // FIXME: make me protected
+
+
+ /** Get the name of that mailbox */
+ const char *getName();
+
+ /** Retrieve the mailbox associated to the given string (as a C string) */
+ static MailboxPtr byName(const char *name);
-private:
- std::string p_name;
- smx_rdv_t p_inferior;
- static boost::unordered_map<std::string, Mailbox *> *channels;
+ /** Retrieve the mailbox associated to the given string (as a C++ string) */
+ static MailboxPtr byName(std::string name);
+
+ /** Returns whether the mailbox contains queued communications */
+ bool empty();
+
+ /** Returns the first element in the queue, or nullptr if none is there */
+ smx_activity_t front();
+
+ /** 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(ActorPtr process);
+
+ /** Return the process declared as permanent receiver, or nullptr if none **/
+ ActorPtr receiver();
};
+
}} // namespace simgrid::s4u
#endif /* SIMGRID_S4U_MAILBOX_HPP */
