Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
make sure that simgrid/s4u/forward.hpp is loaded from only one file
[simgrid.git] / include / simgrid / s4u / Mailbox.hpp
index 9ccf53d..34326a7 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2018. 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,13 +6,11 @@
 #ifndef SIMGRID_S4U_MAILBOX_HPP
 #define SIMGRID_S4U_MAILBOX_HPP
 
-#include <string>
-
-#include <xbt/base.h>
-
-#include <simgrid/s4u/forward.hpp>
+#include <xbt/string.hpp>
 #include <simgrid/s4u/Actor.hpp>
 
+#include <string>
+
 namespace simgrid {
 namespace s4u {
 
@@ -103,9 +101,8 @@ namespace s4u {
  *
  * @section s4u_mb_api The API
  */
-XBT_PUBLIC_CLASS Mailbox {
+class XBT_PUBLIC Mailbox {
   friend Comm;
-  friend simgrid::s4u::Engine;
   friend simgrid::kernel::activity::MailboxImpl;
 
   simgrid::kernel::activity::MailboxImpl* pimpl_;
@@ -118,10 +115,22 @@ XBT_PUBLIC_CLASS Mailbox {
   friend void intrusive_ptr_release(Mailbox*) {}
 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();
+  kernel::activity::MailboxImpl* get_impl() { return pimpl_; }
+
+  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_name()") const simgrid::xbt::string& getName() const
+  {
+    return get_name();
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_cname()") const char* getCname() const { return get_cname(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_impl()") kernel::activity::MailboxImpl* getImpl()
+  {
+    return get_impl();
+  }
+
+  /** @brief Retrieves the name of that mailbox as a C++ string */
+  const simgrid::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 C string */
   static MailboxPtr byName(const char *name);
@@ -152,17 +161,14 @@ public:
   /** Creates (but don't start) a data emission to that mailbox */
   CommPtr put_init();
   /** Creates (but don't start) a data emission to that mailbox */
-  CommPtr put_init(void* data, double simulatedSizeInBytes);
+  CommPtr put_init(void* data, uint64_t simulatedSizeInBytes);
   /** Creates and start a data emission to that mailbox */
-  CommPtr put_async(void* data, double simulatedSizeInBytes);
+  CommPtr put_async(void* data, uint64_t simulatedSizeInBytes);
 
-  /** Blocking data emission
-   *
-   * simulatedSizeInBytes must be a double so that you can send more than 4Gb even if the simulator runs on 32 bits
-   */
-  void put(void* payload, double simulatedSizeInBytes);
+  /** Blocking data emission */
+  void put(void* payload, uint64_t simulatedSizeInBytes);
   /** Blocking data emission with timeout */
-  void put(void* payload, double simulatedSizeInBytes, double timeout);
+  void put(void* payload, uint64_t simulatedSizeInBytes, double timeout);
 
   /** Creates (but don't start) a data reception onto that mailbox */
   CommPtr get_init();