X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/63225b9520042ef129adb975132fe68ec5710988..a6ceacf3b05651e2ae5a40d47c96bdd9fc4d1416:/include/simgrid/s4u/Link.hpp

diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp
index c2e64533ae..284f82c15d 100644
--- a/include/simgrid/s4u/Link.hpp
+++ b/include/simgrid/s4u/Link.hpp
@@ -1,10 +1,10 @@
-/* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2021. 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>
@@ -24,7 +24,11 @@ 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) */
+/**
+ * @beginrst
+ * 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;
 
@@ -48,36 +52,70 @@ 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/Set the bandwidth of the current Link (in bytes per second) */
   double get_bandwidth() const;
+  Link* set_bandwidth(double value);
 
-  /** @brief Get the latency in seconds of current Link */
+  /** Get/Set the latency of the current Link (in seconds) */
   double get_latency() const;
+  /**
+   * @brief Set link's latency
+   *
+   * @param value New latency value (in s)
+   */
+  Link* set_latency(double value);
+  /**
+   * @brief Set latency (string version)
+   *
+   * @throw std::invalid_argument if latency format is incorrect.
+   */
+  Link* set_latency(const std::string& value);
 
   /** @brief Describes how the link is shared between flows */
+  Link* set_sharing_policy(SharingPolicy policy);
   SharingPolicy get_sharing_policy() const;
 
-  /** @brief Returns the current load (in flops per second) */
+  /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
+  Link* set_state_profile(kernel::profile::Profile* profile);
+  /** Setup the profile with bandwidth events (peak speed changes due to external load).
+   * The profile must contain percentages (value between 0 and 1). */
+  Link* set_bandwidth_profile(kernel::profile::Profile* profile);
+  /** Setup the profile file with latency events (peak latency changes due to external load).
+   * The profile must contain absolute values */
+  Link* set_latency_profile(kernel::profile::Profile* profile);
+
+  const std::unordered_map<std::string, std::string>* get_properties() const;
+  const char* get_property(const std::string& key) const;
+  Link* set_properties(const std::unordered_map<std::string, std::string>& properties);
+  Link* set_property(const std::string& key, const std::string& value);
+
+  /** @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() const;
 
+  /** @brief Check if the Link is shared (not a FATPIPE) */
+  bool is_shared() const;
+
   void turn_on();
-  bool is_on() const;
   void turn_off();
+  bool is_on() const;
 
-  /** 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).
-   * The profile must contain percentages (value between 0 and 1). */
-  void set_bandwidth_profile(kernel::profile::Profile* profile);
-  /** Setup the profile file with latency events (peak latency changes due to external load).
-   * The profile must contain absolute values */
-  void set_latency_profile(kernel::profile::Profile* profile);
-
-  const char* get_property(const std::string& key) const;
-  void set_property(const std::string& key, const std::string& value);
+  void seal();
 
   /* The signals */
   /** @brief Callback signal fired when a new Link is created */
@@ -93,7 +131,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)>
@@ -102,4 +140,4 @@ public:
 } // namespace s4u
 } // namespace simgrid
 
-#endif /* SURF_NETWORK_INTERFACE_HPP_ */
+#endif /* S4U_LINK_HPP */