1 /* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_S4U_MAILBOX_HPP
7 #define SIMGRID_S4U_MAILBOX_HPP
11 #include <boost/intrusive_ptr.hpp>
15 #include <simgrid/s4u/forward.hpp>
16 #include <simgrid/s4u/actor.hpp>
23 * Rendez-vous point for network communications, similar to URLs on which you could post and retrieve data.
24 * They are not network locations: you can post and retrieve on a given mailbox from anywhere on the network.
25 * You can access any mailbox without any latency. The network delay are only related to the location of the
26 * sender and receiver.
28 XBT_PUBLIC_CLASS Mailbox {
30 friend simgrid::s4u::Engine;
31 friend simgrid::simix::Mailbox;
35 Mailbox(smx_mailbox_t mbox): pimpl_(mbox) {}
38 smx_mailbox_t getImpl() { return pimpl_; }
42 // We don't have to manage the lifetime of mailboxes:
43 friend void intrusive_ptr_add_ref(Mailbox*) {}
44 friend void intrusive_ptr_release(Mailbox*) {}
45 using Ptr = boost::intrusive_ptr<Mailbox>;
47 /** Get the name of that mailbox */
48 const char *getName();
50 /** Retrieve the mailbox associated to the given string */
51 static Ptr byName(const char *name);
53 /** Returns whether the mailbox contains queued communications */
56 /** Declare that the specified process is a permanent receiver on that mailbox
58 * It means that the communications sent to this mailbox will start flowing to its host even before he does a recv().
59 * This models the real behavior of TCP and MPI communications, amongst other.
61 void setReceiver(Actor* process);
63 /** Return the process declared as permanent receiver, or nullptr if none **/
67 using MailboxPtr = Mailbox::Ptr;
69 }} // namespace simgrid::s4u
71 XBT_PUBLIC(sg_mbox_t) sg_mbox_by_name(const char*name);
72 XBT_PUBLIC(int) sg_mbox_is_empty(sg_mbox_t mbox);
73 XBT_PUBLIC(void)sg_mbox_setReceiver(sg_mbox_t mbox, smx_process_t process);
74 XBT_PUBLIC(smx_process_t) sg_mbox_receiver(sg_mbox_t mbox);
76 #endif /* SIMGRID_S4U_MAILBOX_HPP */