uppercase the s4u header files (+cleanups)

[simgrid.git] / include / simgrid / s4u / Mailbox.hpp

diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp
index 78354d4..62c36fd 100644 (file)
--- a/include/simgrid/s4u/Mailbox.hpp
+++ b/include/simgrid/s4u/Mailbox.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2017. 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. */
@@ -67,8 +67,8 @@ namespace s4u {
  * cumbersome for your simulations anyway. You probably want something
  * simpler, that turns our to be easy to build with the mailboxes.
  *
- * Many examples in the archive use a sort of yellow page system where
- * the mailbox names are the name of the service (such as "worker",
+ * Many SimGrid examples use a sort of yellow page system where the
+ * mailbox names are the name of the service (such as "worker",
  * "master" or "reducer"). That way, you don't have to know where your
  * peer is located to contact it. You don't even need its name. Its
  * function is enough for that. This also gives you some sort of load
@@ -76,6 +76,15 @@ namespace s4u {
  * the first relevant actor that can deal with the request will handle
  * it.
  *
+ * @section s4u_mb_matching How are sends and receives matched?
+ *
+ * The matching algorithm is as simple as a first come, first
+ * serve. When a new send arrives, it matches the oldest enqueued
+ * receive. If no receive is currently enqueued, then the incomming
+ * send is enqueued. As you can see, the mailbox cannot contain both
+ * send and receive requests: all enqueued requests must be of the
+ * same sort.
+ *
  * @section s4u_mb_receiver Declaring a receiving actor
  *
  * The last twist is that by default in the simulator, the data starts
@@ -97,11 +106,11 @@ namespace s4u {
 XBT_PUBLIC_CLASS Mailbox {
   friend Comm;
   friend simgrid::s4u::Engine;
-  friend simgrid::simix::Mailbox;
+  friend simgrid::kernel::activity::MailboxImpl;
 
-  simgrid::simix::Mailbox *pimpl_;
+  simgrid::kernel::activity::MailboxImpl* pimpl_;
 
-  Mailbox(smx_mailbox_t mbox): pimpl_(mbox) {}
+  explicit Mailbox(kernel::activity::MailboxImpl * mbox) : pimpl_(mbox) {}
 
   /** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */
   friend void intrusive_ptr_add_ref(Mailbox*) {}
@@ -109,10 +118,10 @@ XBT_PUBLIC_CLASS Mailbox {
   friend void intrusive_ptr_release(Mailbox*) {}
 public:
   /** private function, do not use. FIXME: make me protected */
-  smx_mailbox_t getImpl() { return pimpl_; }
+  kernel::activity::MailboxImpl* getImpl() { return pimpl_; }
 
   /** Gets the name of that mailbox */
-  const char *getName();
+  const char *name();
 
   /** Retrieve the mailbox associated to the given C string */
   static MailboxPtr byName(const char *name);
@@ -123,6 +132,9 @@ public:
   /** Returns whether the mailbox contains queued communications */
   bool empty();
 
+  /** Check if there is a communication going on in a mailbox. */
+  bool listen();
+
   /** Gets the first element in the queue (without dequeuing it), or nullptr if none is there */
   smx_activity_t front();