X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/05bf7d8e4e62e224875308513bc22fe18bcdbcaa..6bc18b576fa4a890d8b9916d292ca67dfbf60dd3:/include/simgrid/s4u/Mailbox.hpp diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp index ab4db6d1a0..9e41dc1f63 100644 --- a/include/simgrid/s4u/Mailbox.hpp +++ b/include/simgrid/s4u/Mailbox.hpp @@ -102,8 +102,10 @@ namespace s4u { * @section s4u_mb_api The API */ class XBT_PUBLIC Mailbox { +#ifndef DOXYGEN friend Comm; friend simgrid::kernel::activity::MailboxImpl; +#endif simgrid::kernel::activity::MailboxImpl* pimpl_; @@ -122,10 +124,7 @@ public: /** @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 by_name(const char* name); - - /** Retrieve the mailbox associated to the given C++ string */ + /** Retrieve the mailbox associated to the given name */ static MailboxPtr by_name(std::string name); /** Returns whether the mailbox contains queued communications */ @@ -171,24 +170,31 @@ public: void* get(double timeout); // Deprecated functions + /** @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 simgrid::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 MailboxPtr byName(const char* name) { return by_name(name); } + /** @deprecated Mailbox::by_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(std::string name) { return by_name(name);