#endif
public:
- enum class SharingPolicy { NONLINEAR = 4, WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
+ /** Specifies how a given link is shared between concurrent communications */
+ enum class SharingPolicy {
+ /// This policy takes a callback that specifies the maximal capacity as a function of the number of usage. See the
+ /// examples with 'degradation' in their name.
+ NONLINEAR = 4,
+ /// Pseudo-sharing policy requesting wifi-specific sharing.
+ WIFI = 3,
+ /// Each link is split in 2, UP and DOWN, one per direction. These links are SHARED.
+ SPLITDUPLEX = 2,
+ /// The bandwidth is shared between all comms using that link, regardless of their direction.
+ SHARED = 1,
+ /// Each comm can use the link fully, with no sharing (only a maximum). This is intended to represent the backbone
+ /// links that cannot be saturated by concurrent links, but have a maximal bandwidth.
+ FATPIPE = 0
+ };
kernel::resource::StandardLinkImpl* get_impl() const;
- /** @brief Retrieve a link from its name */
+ /** \static @brief Retrieve a link from its name */
static Link* by_name(const std::string& name);
static Link* by_name_or_null(const std::string& name);
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;
+ double get_load() const;
+
+#ifndef DOXYGEN
+ XBT_ATTRIB_DEPRECATED_v338("Please use get_load() instead") double get_usage() const { return get_load(); }
+#endif
/** @brief Check if the Link is used (at least one flow uses the link) */
bool is_used() const;
private:
#ifndef DOXYGEN
static xbt::signal<void(Link&)> on_creation;
- static xbt::signal<void(Link const&)> on_state_change;
+ static xbt::signal<void(Link const&)> on_onoff;
+ xbt::signal<void(Link const&)> on_this_onoff;
static xbt::signal<void(Link const&)> on_bandwidth_change;
+ xbt::signal<void(Link const&)> on_this_bandwidth_change;
static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
on_communication_state_change;
static xbt::signal<void(Link const&)> on_destruction;
+ xbt::signal<void(Link const&)> on_this_destruction;
#endif
public:
/* The signals */
- /** @brief Add a callback fired when a new Link is created */
+ /** \static @brief Add a callback fired when a new Link is created */
static void on_creation_cb(const std::function<void(Link&)>& cb) { on_creation.connect(cb); }
- /** @brief Add a callback fired when the state of a Link changes (when it is turned on or off) */
- static void on_state_change_cb(const std::function<void(Link const&)>& cb) { on_state_change.connect(cb); }
- /** @brief Add a callback fired when the bandwidth of a Link changes */
+ /** \static @brief Add a callback fired when any Link is turned on or off */
+ static void on_onoff_cb(const std::function<void(Link const&)>& cb)
+ {
+ on_onoff.connect(cb);
+ }
+ /** @brief Add a callback fired when this specific Link is turned on or off */
+ void on_this_onoff_cb(const std::function<void(Link const&)>& cb)
+ {
+ on_this_onoff.connect(cb);
+ }
+ /** \static @brief Add a callback fired when the bandwidth of any Link changes */
static void on_bandwidth_change_cb(const std::function<void(Link const&)>& cb) { on_bandwidth_change.connect(cb); }
- /** @brief Add a callback fired when a communication changes it state (ready/done/cancel) */
+ /** @brief Add a callback fired when the bandwidth of this specific Link changes */
+ void on_this_bandwidth_change_cb(const std::function<void(Link const&)>& cb)
+ {
+ on_this_bandwidth_change.connect(cb);
+ }
+ /** \static @brief Add a callback fired when a communication changes it state (ready/done/cancel) */
static void on_communication_state_change_cb(
const std::function<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>& cb)
{
on_communication_state_change.connect(cb);
}
- /** @brief Add a callback fired when a Link is destroyed */
+ /** \static @brief Add a callback fired when any Link is destroyed */
static void on_destruction_cb(const std::function<void(Link const&)>& cb) { on_destruction.connect(cb); }
+ /** @brief Add a callback fired when this specific Link is destroyed */
+ void on_this_destruction_cb(const std::function<void(Link const&)>& cb)
+ {
+ on_this_destruction.connect(cb);
+ }
+
+ XBT_ATTRIB_DEPRECATED_v338("Please use on_onoff_cb() instead") static void on_state_change_cb(
+ const std::function<void(Link const&)>& cb)
+ {
+ on_onoff.connect(cb);
+ }
};
/**
/** @brief Get the link direction down */
Link* get_link_down() const;
- /** @brief Retrieve a link from its name */
+ /** \static @brief Retrieve a link from its name */
static SplitDuplexLink* by_name(const std::string& name);
};