Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid

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

diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp
index f7797dd..3ca3459 100644 (file)
--- a/include/simgrid/s4u/Mailbox.hpp
+++ b/include/simgrid/s4u/Mailbox.hpp
@@ -9,6 +9,7 @@
 #include <string>
 
 #include <xbt/base.h>
+#include <xbt/string.hpp>
 
 #include <simgrid/s4u/forward.hpp>
 #include <simgrid/s4u/Actor.hpp>
@@ -120,8 +121,10 @@ public:
   /** private function, do not use. FIXME: make me protected */
   kernel::activity::MailboxImpl* getImpl() { return pimpl_; }
 
-  /** Gets the name of that mailbox */
-  const char* getName();
+  /** @brief Retrieves the name of that mailbox as a C++ string */
+  const simgrid::xbt::string& getName() const;
+  /** @brief Retrieves the name of that mailbox as a C string */
+  const char* getCname() const;
 
   /** Retrieve the mailbox associated to the given C string */
   static MailboxPtr byName(const char *name);
@@ -149,26 +152,26 @@ public:
   /** Return the actor declared as permanent receiver, or nullptr if none **/
   ActorPtr getReceiver();
 
-  /** Creates (but don't start) an emission to that mailbox */
+  /** Creates (but don't start) a data emission to that mailbox */
   CommPtr put_init();
-  /** Creates (but don't start) an emission to that mailbox */
-  CommPtr put_init(void* data, int simulatedByteAmount);
-  /** Creates and start an async emission to that mailbox */
-  CommPtr put_async(void* data, int simulatedByteAmount);
+  /** Creates (but don't start) a data emission to that mailbox */
+  CommPtr put_init(void* data, uint64_t simulatedSizeInBytes);
+  /** Creates and start a data emission to that mailbox */
+  CommPtr put_async(void* data, uint64_t simulatedSizeInBytes);
 
-  /** Blocking put */
-  void put(void* payload, double simulatedSize);
-  /** Blocking put with timeout */
-  void put(void* payload, double simulatedSize, double timeout);
+  /** Blocking data emission */
+  void put(void* payload, uint64_t simulatedSizeInBytes);
+  /** Blocking data emission with timeout */
+  void put(void* payload, uint64_t simulatedSizeInBytes, double timeout);
 
-  /** Creates (but don't start) a reception onto that mailbox */
+  /** Creates (but don't start) a data reception onto that mailbox */
   CommPtr get_init();
-  /** Creates and start an async reception to that mailbox */
+  /** Creates and start an async data reception to that mailbox */
   CommPtr get_async(void** data);
 
-  /** Blocking reception */
+  /** Blocking data reception */
   void* get();
-  /** Blocking reception with timeout */
+  /** Blocking data reception with timeout */
   void* get(double timeout);
 };