-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2019. 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. */
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;
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 */
/** Turns that host on if it was previously off
*
- * All actors on that host which were marked autorestart will be restarted automatically.
- * This call does nothing if the host is already on.
+ * This call does nothing if the host is already on. If it was off, all actors which were
+ * marked 'autorestart' on that host will be restarted automatically (note that this may differ
+ * from the actors that were initially running on the host).
+ *
+ * All other Host's properties are left unchanged; in particular, the pstate is left
+ * unchanged and not reset to its initial value.
*/
void turn_on();
/** Turns that host off. All actors are forcefully stopped. */
{
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);
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