-/* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2018. 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. */
#ifndef SIMGRID_S4U_MAILBOX_HPP
#define SIMGRID_S4U_MAILBOX_HPP
-#include <string>
-
-#include <xbt/base.h>
-
-#include <simgrid/s4u/forward.hpp>
+#include <xbt/string.hpp>
#include <simgrid/s4u/Actor.hpp>
+#include <string>
+
namespace simgrid {
namespace s4u {
*
* @section s4u_mb_api The API
*/
-XBT_PUBLIC_CLASS Mailbox {
+class XBT_PUBLIC Mailbox {
friend Comm;
- friend simgrid::s4u::Engine;
friend simgrid::kernel::activity::MailboxImpl;
simgrid::kernel::activity::MailboxImpl* pimpl_;
friend void intrusive_ptr_release(Mailbox*) {}
public:
/** private function, do not use. FIXME: make me protected */
- kernel::activity::MailboxImpl* getImpl() { return pimpl_; }
+ kernel::activity::MailboxImpl* get_impl() { 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& 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 C string */
- static MailboxPtr byName(const char *name);
+ static MailboxPtr by_name(const char* name);
/** Retrieve the mailbox associated to the given C++ string */
- static MailboxPtr byName(std::string name);
+ static MailboxPtr by_name(std::string name);
/** Returns whether the mailbox contains queued communications */
bool empty();
* its host even before he does a recv(). This models the real behavior of TCP
* and MPI communications, amongst other.
*/
- void setReceiver(ActorPtr actor);
+ void set_receiver(ActorPtr actor);
/** Return the actor declared as permanent receiver, or nullptr if none **/
- ActorPtr receiver();
+ ActorPtr get_receiver();
+
+ /** 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 simulated_size_in_bytes);
+ /** Creates and start a data emission to that mailbox */
+ CommPtr put_async(void* data, uint64_t simulated_size_in_bytes);
+
+ /** Blocking data emission */
+ void put(void* payload, uint64_t simulated_size_in_bytes);
+ /** Blocking data emission with timeout */
+ void put(void* payload, uint64_t simulated_size_in_bytes, 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(); // FIXME: make a typed template version
+ /** Blocking data reception with timeout */
+ void* get(double timeout);
+
+ // Deprecated functions
+ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::set_receiver()") void setReceiver(ActorPtr actor)
+ {
+ set_receiver(actor);
+ }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_receiver()") ActorPtr getReceiver() { return get_receiver(); }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_name()") const simgrid::xbt::string& getName() const
+ {
+ return get_name();
+ }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_cname()") const char* getCname() const { return get_cname(); }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_impl()") kernel::activity::MailboxImpl* getImpl()
+ {
+ return get_impl();
+ }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(const char* name)
+ {
+ return by_name(name);
+ }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(std::string name)
+ {
+ return by_name(name);
+ }
};
}} // namespace simgrid::s4u