allow to retrieve the source and destination of a host-to-host Comm

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

diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp
index 1ab58c8..5d89a0b 100644 (file)
--- a/include/simgrid/s4u/Link.hpp
+++ b/include/simgrid/s4u/Link.hpp
@@ -42,7 +42,7 @@ protected:
   kernel::resource::LinkImplIntf* const pimpl_;
 
 public:
-  enum class SharingPolicy { WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
+  enum class SharingPolicy { NONLINEAR = 4, WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
 
   kernel::resource::LinkImpl* get_impl() const;
 
@@ -70,12 +70,19 @@ public:
   /**
    * @brief Set latency (string version)
    *
+   * Accepts values with units, such as '1s' or '7ms'.
+   *
+   * Full list of accepted units: w (week), d (day), h, s, ms, us, ns, ps.
+   *
    * @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);
+  /** @brief Describes how the link is shared between flows
+   *
+   *  Note that the NONLINEAR callback is in the critical path of the solver, so it should be fast.
+   */
+  Link* set_sharing_policy(SharingPolicy policy, const NonLinearResourceCb& cb = {});
   SharingPolicy get_sharing_policy() const;
 
   /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
@@ -134,21 +141,18 @@ public:
   /** @brief Callback signal fired when a new Link is created */
   static xbt::signal<void(Link&)> on_creation;
 
-  /** @brief Callback signal fired when a Link is destroyed */
-  static xbt::signal<void(Link const&)> on_destruction;
-
   /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
   static xbt::signal<void(Link const&)> on_state_change;
 
   /** @brief Callback signal fired when the bandwidth of a Link changes */
   static xbt::signal<void(Link const&)> on_bandwidth_change;
 
-  /** @brief Callback signal fired when a communication starts */
-  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)>
       on_communication_state_change;
+
+  /** @brief Callback signal fired when a Link is destroyed */
+  static xbt::signal<void(Link const&)> on_destruction;
 };
 
 /**
@@ -172,12 +176,12 @@ public:
 
 /**
  * @beginrst
- * Another encapsulation for using links in the :cpp:function:: NetZone::add_route
+ * Another encapsulation for using links in the :cpp:func:`NetZone::add_route`
  *
  * When adding a route with split-duplex links, you need to specify the direction of the link
  * so SimGrid can know exactly which physical link to insert in the route.
  *
- * For shared/fat-pipe links, use the Direction::NONE since they don't have
+ * For shared/fat-pipe links, use the :cpp:enumerator:`Direction::NONE` since they don't have
  * the concept of UP/DOWN links.
  * @endrst
  */
@@ -185,7 +189,7 @@ class XBT_PUBLIC LinkInRoute {
 public:
   enum class Direction { UP = 2, DOWN = 1, NONE = 0 };
 
-  LinkInRoute(const Link* link) : link_(link) {}
+  explicit LinkInRoute(const Link* link) : link_(link) {}
   LinkInRoute(const Link* link, Direction d) : link_(link), direction_(d) {}
 
   /** @brief Get direction of this link in the route: UP or DOWN */