Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' into clean_events
[simgrid.git] / include / simgrid / s4u / Mailbox.hpp
index 07925b5..fdd13dd 100644 (file)
@@ -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. */
@@ -26,7 +26,7 @@ namespace s4u {
  * Rendez-vous point for network communications, similar to URLs on
  * which you could post and retrieve data. Actually, the mailboxes are
  * not involved in the communication once it starts, but only to find
- * the contact with which you want to communicate. 
+ * the contact with which you want to communicate.
 
  * Here are some mechanisms similar to the mailbox in other
  * communication systems: The phone number, which allows the caller to
@@ -93,8 +93,8 @@ namespace s4u {
  * starts to flow as soon as the sender posts it, even if the receiver
  * did not post its recv() yet. This can obviously lead to bad
  * simulation timings, as the simulated communications do not start at
- * the exact same time than the real ones. 
- * 
+ * the exact same time than the real ones.
+ *
  * If the simulation timings are very important to you, you can
  * declare a specific receiver to a given mailbox (with the function
  * setReceiver()). That way, any send() posted to that mailbox will
@@ -106,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_;
 
-  explicit 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*) {}
@@ -118,7 +118,7 @@ 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 *name();
@@ -132,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();