#include <string>
#include <xbt/base.h>
+#include <xbt/string.hpp>
#include <simgrid/s4u/forward.hpp>
#include <simgrid/s4u/Actor.hpp>
* Rendez-vous point for network communications, similar to URLs on
* which you could post and retrieve data. Actually, the mailboxes are
* not involved in the communication once it starts, but only to find
- * the contact with which you want to communicate.
+ * the contact with which you want to communicate.
* Here are some mechanisms similar to the mailbox in other
* communication systems: The phone number, which allows the caller to
* starts to flow as soon as the sender posts it, even if the receiver
* did not post its recv() yet. This can obviously lead to bad
* simulation timings, as the simulated communications do not start at
- * the exact same time than the real ones.
- *
+ * the exact same time than the real ones.
+ *
* If the simulation timings are very important to you, you can
* declare a specific receiver to a given mailbox (with the function
* setReceiver()). That way, any send() posted to that mailbox will
*/
XBT_PUBLIC_CLASS Mailbox {
friend Comm;
- friend simgrid::s4u::Engine;
friend simgrid::kernel::activity::MailboxImpl;
simgrid::kernel::activity::MailboxImpl* pimpl_;
/** private function, do not use. FIXME: make me protected */
kernel::activity::MailboxImpl* getImpl() { return pimpl_; }
- /** Gets the name of that mailbox */
- const char *name();
+ /** @brief Retrieves the name of that mailbox as a C++ string */
+ const simgrid::xbt::string& getName() const;
+ /** @brief Retrieves the name of that mailbox as a C string */
+ const char* getCname() const;
/** Retrieve the mailbox associated to the given C string */
static MailboxPtr byName(const char *name);
void setReceiver(ActorPtr actor);
/** Return the actor declared as permanent receiver, or nullptr if none **/
- ActorPtr receiver();
+ ActorPtr getReceiver();
+
+ /** Creates (but don't start) a data emission to that mailbox */
+ CommPtr put_init();
+ /** Creates (but don't start) a data emission to that mailbox */
+ CommPtr put_init(void* data, uint64_t simulatedSizeInBytes);
+ /** Creates and start a data emission to that mailbox */
+ CommPtr put_async(void* data, uint64_t simulatedSizeInBytes);
+
+ /** Blocking data emission */
+ void put(void* payload, uint64_t simulatedSizeInBytes);
+ /** Blocking data emission with timeout */
+ void put(void* payload, uint64_t simulatedSizeInBytes, double timeout);
+
+ /** 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);
+
+ /** Blocking data reception */
+ void* get();
+ /** Blocking data reception with timeout */
+ void* get(double timeout);
};
}} // namespace simgrid::s4u