Fix a few warnings when building doc (mostly related to doxygen).

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

diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp
index 6dbf49e..b000853 100644 (file)
--- a/include/simgrid/s4u/Link.hpp
+++ b/include/simgrid/s4u/Link.hpp
@@ -1,4 +1,4 @@
-/* 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. */
@@ -25,12 +25,14 @@ extern template class XBT_PUBLIC xbt::Extendable<s4u::Link>;
 
 namespace s4u {
 /**
- * @rst
+ * @beginrst
  * A Link represents the network facilities between :cpp:class:`hosts <simgrid::s4u::Host>`.
  * @endrst
  */
 class XBT_PUBLIC Link : public xbt::Extendable<Link> {
+#ifndef DOXYGEN
   friend kernel::resource::LinkImpl;
+#endif
 
   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
   explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
@@ -52,17 +54,53 @@ 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;
-  void set_bandwidth(double value);
+  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;
-  void set_latency(double value);
+  /**
+   * @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;
 
+  /** 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 number of communications that can shared this link at the same time
+   *
+   * Use this method to serialize communication flows going through this link.
+   * Use -1 to set no limit.
+   *
+   * @param limit  Number of concurrent flows
+   */
+  Link* set_concurrency_limit(int limit);
+
   /** @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),
@@ -82,21 +120,14 @@ public:
   /** @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);
+  Link* seal();
 
   /* The signals */
   /** @brief Callback signal fired when a new Link is created */