Merge branch 'master' into adrien

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

diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp
index 8d788ed..11212f9 100644 (file)
--- a/include/simgrid/s4u/Link.hpp
+++ b/include/simgrid/s4u/Link.hpp
@@ -1,10 +1,10 @@
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2020. 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. */
 
-#ifndef S4U_LINK_HPP_
-#define S4U_LINK_HPP_
+#ifndef S4U_LINK_HPP
+#define S4U_LINK_HPP
 
 #include <simgrid/forward.h>
 #include <simgrid/kernel/resource/Action.hpp>
@@ -20,8 +20,15 @@
  ***********/
 
 namespace simgrid {
+
+extern template class XBT_PUBLIC xbt::Extendable<s4u::Link>;
+
 namespace s4u {
-/** @brief A Link represents the network facilities between [hosts](@ref simgrid::s4u::Host) */
+/**
+ * @rst
+ * A Link represents the network facilities between :cpp:class:`hosts <simgrid::s4u::Host>`.
+ * @endrst
+ */
 class XBT_PUBLIC Link : public xbt::Extendable<Link> {
   friend kernel::resource::LinkImpl;
 
@@ -45,43 +52,42 @@ public:
   /** @brief Retrieves the name of that link as a C string */
   const char* get_cname() const;
 
-  /** @brief Get the bandwidth in bytes per second of current Link */
+  /** Get the bandwidth of the current Link (in bytes per second) */
   double get_bandwidth() const;
+  /** Set the bandwidth of the current Link (in bytes per second) */
+  void set_bandwidth(double value);
 
-  /** @brief Get the latency in seconds of current Link */
+  /** Get the latency of the current Link (in seconds) */
   double get_latency() const;
+  /** Set the latency of the current Link (in seconds) */
+  void set_latency(double value);
 
   /** @brief Describes how the link is shared between flows */
-  SharingPolicy get_sharing_policy();
-
-  /** @brief Returns the current load (in flops per second) */
-  double get_usage();
+  SharingPolicy get_sharing_policy() const;
+
+  /** @brief Set the level of communication speed of the given host on this wifi link.
+   *
+   * The bandwidth of a wifi link for a given host depends on its SNR (signal to noise ratio),
+   * which ultimately depends on the distance between the host and the station and the material between them.
+   *
+   * This is modeled in SimGrid by providing several bandwidths to wifi links, one per SNR level (just provide
+   * comma-separated values in the XML file). By default, the first level in the list is used, but you can use the
+   * current function to specify that a given host uses another level of bandwidth. This can be used to take the
+   * location of hosts into account, or even to model mobility in your SimGrid simulation.
+   *
+   * Note that this function asserts that the link is actually a wifi link */
+  void set_host_wifi_rate(const s4u::Host* host, int level) const;
+
+  /** @brief Returns the current load (in bytes per second) */
+  double get_usage() const;
 
   /** @brief Check if the Link is used (at least one flow uses the link) */
-  bool is_used();
+  bool is_used() const;
 
   void turn_on();
   bool is_on() const;
   void turn_off();
 
-#ifndef DOXYGEN
-  XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_state_profile()") void set_state_trace(
-      kernel::profile::Profile* profile)
-  {
-    set_state_profile(profile);
-  }
-  XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_bandwidth_profile()") void set_bandwidth_trace(
-      kernel::profile::Profile* profile)
-  {
-    set_bandwidth_profile(profile);
-  }
-  XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_latency_profile()") void set_latency_trace(
-      kernel::profile::Profile* profile)
-  {
-    set_latency_profile(profile);
-  }
-#endif
-
   /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
   void set_state_profile(kernel::profile::Profile* profile);
   /** Setup the profile with bandwidth events (peak speed changes due to external load).
@@ -108,7 +114,7 @@ public:
   static xbt::signal<void(Link const&)> on_bandwidth_change;
 
   /** @brief Callback signal fired when a communication starts */
-  static xbt::signal<void(kernel::resource::NetworkAction&, Host* src, Host* dst)> on_communicate;
+  static xbt::signal<void(kernel::resource::NetworkAction&)> on_communicate;
 
   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
   static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
@@ -117,4 +123,4 @@ public:
 } // namespace s4u
 } // namespace simgrid
 
-#endif /* SURF_NETWORK_INTERFACE_HPP_ */
+#endif /* S4U_LINK_HPP */