Merge remote-tracking branch 'upstream/master'

[simgrid.git] / src / s4u / s4u_Mailbox.cpp

diff --git a/src/s4u/s4u_Mailbox.cpp b/src/s4u/s4u_Mailbox.cpp
index f57874e..7c3841e 100644 (file)
--- a/src/s4u/s4u_Mailbox.cpp
+++ b/src/s4u/s4u_Mailbox.cpp
@@ -26,7 +26,7 @@ const char* Mailbox::get_cname() const
   return pimpl_->get_cname();
 }
 
-MailboxPtr Mailbox::byName(const char* name)
+MailboxPtr Mailbox::by_name(const char* name)
 {
   kernel::activity::MailboxImpl* mbox = kernel::activity::MailboxImpl::byNameOrNull(name);
   if (mbox == nullptr) {
@@ -35,9 +35,9 @@ MailboxPtr Mailbox::byName(const char* name)
   return MailboxPtr(&mbox->piface_, true);
 }
 
-MailboxPtr Mailbox::byName(std::string name)
+MailboxPtr Mailbox::by_name(std::string name)
 {
-  return byName(name.c_str());
+  return by_name(name.c_str());
 }
 
 bool Mailbox::empty()
@@ -55,13 +55,13 @@ smx_activity_t Mailbox::front()
   return pimpl_->comm_queue.empty() ? nullptr : pimpl_->comm_queue.front();
 }
 
-void Mailbox::setReceiver(ActorPtr actor)
+void Mailbox::set_receiver(ActorPtr actor)
 {
   simix::simcall([this, actor]() { this->pimpl_->setReceiver(actor); });
 }
 
 /** @brief get the receiver (process associated to the mailbox) */
-ActorPtr Mailbox::getReceiver()
+ActorPtr Mailbox::get_receiver()
 {
   if (pimpl_->permanent_receiver == nullptr)
     return ActorPtr();
@@ -75,38 +75,38 @@ CommPtr Mailbox::put_init()
   res->mailbox_ = this;
   return res;
 }
-s4u::CommPtr Mailbox::put_init(void* data, uint64_t simulatedSize)
+s4u::CommPtr Mailbox::put_init(void* data, uint64_t simulated_size_in_bytes)
 {
   s4u::CommPtr res = put_init();
-  res->set_remaining(simulatedSize);
+  res->set_remaining(simulated_size_in_bytes);
   res->src_buff_      = data;
   res->src_buff_size_ = sizeof(void*);
   return res;
 }
-s4u::CommPtr Mailbox::put_async(void* payload, uint64_t simulatedSize)
+s4u::CommPtr Mailbox::put_async(void* payload, uint64_t simulated_size_in_bytes)
 {
   xbt_assert(payload != nullptr, "You cannot send nullptr");
 
-  s4u::CommPtr res = put_init(payload, simulatedSize);
+  s4u::CommPtr res = put_init(payload, simulated_size_in_bytes);
   res->start();
   return res;
 }
-void Mailbox::put(void* payload, uint64_t simulatedSize)
+void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes)
 {
   xbt_assert(payload != nullptr, "You cannot send nullptr");
 
   CommPtr c = put_init();
-  c->set_remaining(simulatedSize);
+  c->set_remaining(simulated_size_in_bytes);
   c->set_src_data(payload);
   c->wait();
 }
 /** Blocking send with timeout */
-void Mailbox::put(void* payload, uint64_t simulatedSize, double timeout)
+void Mailbox::put(void* payload, uint64_t simulated_size_in_bytes, double timeout)
 {
   xbt_assert(payload != nullptr, "You cannot send nullptr");
 
   CommPtr c = put_init();
-  c->set_remaining(simulatedSize);
+  c->set_remaining(simulated_size_in_bytes);
   c->set_src_data(payload);
   // c->start() is optional.
   c->wait(timeout);
@@ -145,3 +145,28 @@ void* Mailbox::get(double timeout)
 }
 } // namespace s4u
 } // namespace simgrid
+
+/* **************************** Public C interface *************************** */
+/** \brief Set the mailbox to receive in asynchronous mode
+ *
+ * All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call.
+ * The receive call will still be necessary to use the received data.
+ * If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.
+ *
+ * \param alias The name of the mailbox
+ */
+void sg_mailbox_set_receiver(const char* alias)
+{
+  simgrid::s4u::Mailbox::by_name(alias)->set_receiver(simgrid::s4u::Actor::self());
+  XBT_VERB("%s mailbox set to receive eagerly for myself\n", alias);
+}
+
+/** \brief Check if there is a communication going on in a mailbox.
+ *
+ * \param alias the name of the mailbox to be considered
+ * \return Returns 1 if there is a communication, 0 otherwise
+ */
+int sg_mailbox_listen(const char* alias)
+{
+  return simgrid::s4u::Mailbox::by_name(alias)->listen() ? 1 : 0;
+}