X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/65beede857f93e33c96e544f76b93793c973dc10..d6a9ae11bd2ff9b0bf30bf84cbedfe0438a5051e:/include/simgrid/s4u/Mailbox.hpp diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp index 069618a9df..35a9db76fc 100644 --- a/include/simgrid/s4u/Mailbox.hpp +++ b/include/simgrid/s4u/Mailbox.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2020. 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 #include @@ -17,6 +19,7 @@ namespace s4u { /** @brief Mailboxes: Network rendez-vous points. */ class XBT_PUBLIC Mailbox { friend Comm; + friend smpi::Request; friend kernel::activity::MailboxImpl; kernel::activity::MailboxImpl* const pimpl_; @@ -24,29 +27,32 @@ class XBT_PUBLIC Mailbox { explicit Mailbox(kernel::activity::MailboxImpl * mbox) : pimpl_(mbox) {} ~Mailbox() = default; -public: - /** private function, do not use. FIXME: make me protected */ - kernel::activity::MailboxImpl* get_impl() { return pimpl_; } +protected: + kernel::activity::MailboxImpl* get_impl() const { return pimpl_; } +public: /** @brief Retrieves the name of that mailbox as a C++ string */ 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 */ + /** Retrieve the mailbox associated to the given name. Mailboxes are created on demand. */ static Mailbox* by_name(const std::string& name); /** Returns whether the mailbox contains queued communications */ - bool empty(); + bool empty() const; /** Check if there is a communication going on in a mailbox. */ - bool listen(); + bool listen() const; + + /** Look if there is a communication going on in a mailbox and return the PID of the sender actor */ + aid_t listen_from() const; /** Check if there is a communication ready to be consumed from a mailbox. */ - bool ready(); + bool ready() const; /** Gets the first element in the queue (without dequeuing it), or nullptr if none is there */ - kernel::activity::CommImplPtr front(); + kernel::activity::CommImplPtr front() const; /** Declare that the specified actor is a permanent receiver on that mailbox * @@ -69,7 +75,7 @@ public: void set_receiver(ActorPtr actor); /** Return the actor declared as permanent receiver, or nullptr if none **/ - ActorPtr get_receiver(); + ActorPtr get_receiver() const; /** Creates (but don't start) a data transmission to that mailbox */ CommPtr put_init(); @@ -78,7 +84,8 @@ public: /** Creates and start a data transmission to that mailbox */ CommPtr put_async(void* data, uint64_t simulated_size_in_bytes); - smx_activity_t iprobe(int type, int (*match_fun)(void*, void*, kernel::activity::CommImpl*), void* data); + kernel::activity::ActivityImplPtr 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 transmission with timeout */