py: another example: actor-join

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

diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp
index d46e699..88ac89d 100644 (file)
--- a/include/simgrid/s4u/Host.hpp
+++ b/include/simgrid/s4u/Host.hpp
@@ -52,7 +52,7 @@ private:
 public:
   /*** Called on each newly created host */
   static simgrid::xbt::signal<void(Host&)> on_creation;
-  /*** Called just before destructing an host */
+  /*** Called just before destructing a host */
   static simgrid::xbt::signal<void(Host&)> on_destruction;
   /*** Called when the machine is turned on or off (called AFTER the change) */
   static simgrid::xbt::signal<void(Host&)> on_state_change;
@@ -65,11 +65,11 @@ public:
   Host(Host const&) = delete;
   Host& operator=(Host const&) = delete;
 
-  /** Retrieves an host from its name, or return nullptr */
+  /** Retrieve a host from its name, or return nullptr */
   static Host* by_name_or_null(std::string name);
-  /** Retrieves an host from its name, or die */
+  /** Retrieve a host from its name, or die */
   static s4u::Host* by_name(std::string name);
-  /** Retrieves the host on which the current actor is running */
+  /** Retrieves the host on which the running actor is located */
   static s4u::Host* current();
 
   /** Retrieves the name of that host as a C++ string */
@@ -127,22 +127,24 @@ public:
   {
     return get_pstate_speed(pstate_index);
   }
-#endif
 
   std::vector<const char*> get_attached_storages() const;
   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
       std::vector<const char*>* storages);
+#endif
 
   /** Get an associative list [mount point]->[Storage] of all local mount points.
    *
    *  This is defined in the platform file, and cannot be modified programatically (yet).
    */
   std::unordered_map<std::string, Storage*> const& get_mounted_storages();
+#ifndef DOXYGEN
   /** @deprecated See Host::get_mounted_storages() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map<std::string, Storage*> const& getMountedStorages()
   {
     return get_mounted_storages();
   }
+#endif
 
   void route_to(Host* dest, std::vector<Link*>& links, double* latency);
   void route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
@@ -153,6 +155,9 @@ public:
    * The actor will not be migrated in this case. Such remote execution are easy in simulation.
    */
   void execute(double flops);
+  /** Start an asynchronous computation on that host (possibly remote) */
+  ExecPtr exec_async(double flops_amounts);
+
   /** Block the calling actor on an execution located on the called host (with explicit priority) */
   void execute(double flops, double priority);
 
@@ -217,12 +222,14 @@ private:
   std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
 
 public:
+#ifndef DOXYGEN
   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
   surf::Cpu* pimpl_cpu = nullptr;
   // TODO, this could be a unique_ptr
   surf::HostImpl* pimpl_ = nullptr;
   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
   kernel::routing::NetPoint* pimpl_netpoint = nullptr;
+#endif
 };
 }
 } // namespace simgrid::s4u