namespace simgrid {
namespace s4u {
/** @brief A Link represents the network facilities between [hosts](@ref simgrid::s4u::Host) */
-class XBT_PUBLIC Link : public simgrid::xbt::Extendable<Link> {
- friend simgrid::kernel::resource::LinkImpl;
+class XBT_PUBLIC Link : public xbt::Extendable<Link> {
+ friend kernel::resource::LinkImpl;
// Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
kernel::resource::LinkImpl* get_impl() { return pimpl_; }
/** @brief Retrieve a link from its name */
- static Link* by_name(std::string name);
- static Link* by_name_or_null(std::string name);
+ static Link* by_name(const std::string& name);
+ static Link* by_name_or_null(const std::string& name);
/** @brief Retrieves the name of that link as a C++ string */
const std::string& get_name() const;
const char* get_cname() const;
/** @brief Get the bandwidth in bytes per second of current Link */
- double get_bandwidth();
+ double get_bandwidth() const;
/** @brief Get the latency in seconds of current Link */
- double get_latency();
+ double get_latency() const;
/** @brief Describes how the link is shared between flows */
SharingPolicy get_sharing_policy();
bool is_used();
void turn_on();
- bool is_on();
+ bool is_on() const;
void turn_off();
- bool is_off();
void* get_data(); /** Should be used only from the C interface. Prefer extensions in C++ */
void set_data(void* d);
* The profile must contain absolute values */
void set_latency_profile(kernel::profile::Profile* profile);
- const char* get_property(std::string key);
- void set_property(std::string key, std::string value);
+ const char* get_property(const std::string& key);
+ void set_property(const std::string& key, const std::string& value);
/* The signals */
/** @brief Callback signal fired when a new Link is created */
- static simgrid::xbt::signal<void(s4u::Link&)> on_creation;
+ static xbt::signal<void(Link&)> on_creation;
/** @brief Callback signal fired when a Link is destroyed */
- static simgrid::xbt::signal<void(s4u::Link&)> on_destruction;
+ static xbt::signal<void(Link&)> on_destruction;
/** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
- static simgrid::xbt::signal<void(s4u::Link&)> on_state_change;
+ static xbt::signal<void(Link&)> on_state_change;
/** @brief Callback signal fired when the bandwidth of a Link changes */
- static simgrid::xbt::signal<void(s4u::Link&)> on_bandwidth_change;
+ static xbt::signal<void(Link&)> on_bandwidth_change;
/** @brief Callback signal fired when a communication starts */
- static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, s4u::Host* src, s4u::Host* dst)> on_communicate;
+ static xbt::signal<void(kernel::resource::NetworkAction*, Host* src, Host* dst)> on_communicate;
/** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
- static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, kernel::resource::Action::State)>
+ static xbt::signal<void(kernel::resource::NetworkAction*, kernel::resource::Action::State)>
on_communication_state_change;
#ifndef DOXYGEN
/** @deprecated */
XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_property()") const char* getProperty(const char* key) {return get_property(key);}
/** @deprecated */
- XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(std::string key, std::string value) {set_property(key, value);}
+ XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(const std::string& key,
+ const std::string& value)
+ {
+ set_property(key, value);
+ }
/** @deprecated */
XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_data()") void* getData() {return get_data();}
/** @deprecated */
XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_profile()") void setStateTrace(
- simgrid::kernel::profile::Profile* profile) {set_state_profile(profile); }
+ kernel::profile::Profile* profile)
+ {
+ set_state_profile(profile);
+ }
/** @deprecated */
XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_profile()") void setBandwidthTrace(
- simgrid::kernel::profile::Profile* profile) { set_bandwidth_profile(profile); }
+ kernel::profile::Profile* profile)
+ {
+ set_bandwidth_profile(profile);
+ }
/** @deprecated */
XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_profile()") void setLatencyTrace(
- simgrid::kernel::profile::Profile* profile) { set_latency_profile(profile); }
+ kernel::profile::Profile* profile)
+ {
+ set_latency_profile(profile);
+ }
#endif
};
-}
-}
+} // namespace s4u
+} // namespace simgrid
#endif /* SURF_NETWORK_INTERFACE_HPP_ */