X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/abd5b5ad635e4b5decbe062435ca0edcaf4b0503..e04e3ae8fec7cb28eef7705e4aebf2370e6fdd6a:/include/simgrid/s4u/Mailbox.hpp diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp index 630d238aab..94a58bc4b6 100644 --- a/include/simgrid/s4u/Mailbox.hpp +++ b/include/simgrid/s4u/Mailbox.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2019. 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. */ @@ -6,8 +6,10 @@ #ifndef SIMGRID_S4U_MAILBOX_HPP #define SIMGRID_S4U_MAILBOX_HPP -#include +#include + #include +#include #include @@ -16,28 +18,25 @@ namespace s4u { /** @brief Mailboxes: Network rendez-vous points. */ class XBT_PUBLIC Mailbox { - friend simgrid::s4u::Comm; - friend simgrid::kernel::activity::MailboxImpl; + friend Comm; + friend kernel::activity::MailboxImpl; - simgrid::kernel::activity::MailboxImpl* pimpl_; + kernel::activity::MailboxImpl* const pimpl_; explicit Mailbox(kernel::activity::MailboxImpl * mbox) : pimpl_(mbox) {} + ~Mailbox() = default; - /** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */ - friend void intrusive_ptr_add_ref(Mailbox*) {} - /** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */ - friend void intrusive_ptr_release(Mailbox*) {} public: /** private function, do not use. FIXME: make me protected */ - kernel::activity::MailboxImpl* get_impl() { return pimpl_; } + kernel::activity::MailboxImpl* get_impl() const { return pimpl_; } /** @brief Retrieves the name of that mailbox as a C++ string */ - const simgrid::xbt::string& get_name() const; + const 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 name */ - static MailboxPtr by_name(std::string name); + static Mailbox* by_name(const std::string& name); /** Returns whether the mailbox contains queued communications */ bool empty(); @@ -49,7 +48,7 @@ public: bool ready(); /** Gets the first element in the queue (without dequeuing it), or nullptr if none is there */ - smx_activity_t front(); + kernel::activity::CommImplPtr front(); /** Declare that the specified actor is a permanent receiver on that mailbox * @@ -74,16 +73,17 @@ public: /** Return the actor declared as permanent receiver, or nullptr if none **/ ActorPtr get_receiver(); - /** Creates (but don't start) a data emission to that mailbox */ + /** Creates (but don't start) a data transmission to that mailbox */ CommPtr put_init(); - /** Creates (but don't start) a data emission to that mailbox */ + /** Creates (but don't start) a data transmission to that mailbox */ CommPtr put_init(void* data, uint64_t simulated_size_in_bytes); - /** Creates and start a data emission to that mailbox */ + /** Creates and start a data transmission to that mailbox */ CommPtr put_async(void* data, uint64_t simulated_size_in_bytes); - /** Blocking data emission */ + smx_activity_t iprobe(int type, bool (*match_fun)(void*, void*, kernel::activity::CommImpl*), void* data); + /** Blocking data transmission */ void put(void* payload, uint64_t simulated_size_in_bytes); - /** Blocking data emission with timeout */ + /** Blocking data transmission 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 */ @@ -95,39 +95,9 @@ public: void* get(); // FIXME: make a typed template version /** Blocking data reception with timeout */ 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); - } }; -}} // namespace simgrid::s4u +} // namespace s4u +} // namespace simgrid #endif /* SIMGRID_S4U_MAILBOX_HPP */