X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c133313ec220e0c3c2f438e26b7485cef410b2ff..dd60a691bb83ef59ac7395b8e842712271774e18:/include/simgrid/s4u/Link.hpp diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp index b9ae777b47..c34383a283 100644 --- a/include/simgrid/s4u/Link.hpp +++ b/include/simgrid/s4u/Link.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2019. 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. */ @@ -6,6 +6,7 @@ #ifndef S4U_LINK_HPP_ #define S4U_LINK_HPP_ +#include #include #include #include @@ -19,7 +20,7 @@ namespace simgrid { namespace s4u { -/** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */ +/** @brief A Link represents the network facilities between [hosts](@ref simgrid::s4u::Host) */ class XBT_PUBLIC Link : public simgrid::xbt::Extendable { friend simgrid::kernel::resource::LinkImpl; @@ -32,8 +33,11 @@ class XBT_PUBLIC Link : public simgrid::xbt::Extendable { public: enum class SharingPolicy { SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 }; + kernel::resource::LinkImpl* get_impl() { return pimpl_; } + /** @brief Retrieve a link from its name */ - static Link* by_name(const char* name); + static Link* by_name(std::string name); + static Link* by_name_or_null(std::string name); /** @brief Retrieves the name of that link as a C++ string */ const std::string& get_name() const; @@ -56,19 +60,41 @@ public: bool is_used(); void turn_on(); + bool is_on() const; void turn_off(); + bool is_off() const; void* get_data(); /** Should be used only from the C interface. Prefer extensions in C++ */ void set_data(void* d); - void set_state_trace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain - boolean values. */ - void set_bandwidth_trace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to - external load). Trace must contain percentages (value between 0 and 1). */ - void set_latency_trace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to - external load). Trace must contain absolute values */ - - const char* get_property(const char* key); +#ifndef DOXYGEN + XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_state_profile()") void set_state_trace( + kernel::profile::Profile* profile) + { + set_state_profile(profile); + } + XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_bandwidth_profile()") void set_bandwidth_trace( + kernel::profile::Profile* profile) + { + set_bandwidth_profile(profile); + } + XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_latency_profile()") void set_latency_trace( + kernel::profile::Profile* profile) + { + set_latency_profile(profile); + } +#endif + + /** 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(std::string key); void set_property(std::string key, std::string value); /* The signals */ @@ -88,31 +114,53 @@ public: static simgrid::xbt::signal on_communicate; /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */ - static simgrid::xbt::signal on_communication_state_change; + static simgrid::xbt::signal + on_communication_state_change; +#ifndef DOXYGEN // Deprecated methods - XBT_ATTRIB_DEPRECATED_v321("Use get_cname(): v3.21 will turn this warning into an error.") const char* name(); + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); } + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); } + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); } + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_sharing_policy()") SharingPolicy sharingPolicy() {return get_sharing_policy();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_usage()") double getUsage() {return get_usage();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::is_used()") bool isUsed() {return is_used();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth()") double bandwidth() {return get_bandwidth();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency()") double latency() {return get_latency();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_on()") void turnOn() {turn_on();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_off()") void turnOff() {turn_off();} + /** @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);} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_data()") void* getData() {return get_data();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_data()") void setData(void* d) {set_data(d);} - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_trace()") void setStateTrace(tmgr_trace_t trace) {set_state_trace(trace);} - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_trace()") void setBandwidthTrace(tmgr_trace_t trace) {set_bandwidth_trace(trace);} - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_trace()") void setLatencyTrace(tmgr_trace_t trace) {set_latency_trace(trace);} + /** @deprecated */ + XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_profile()") void setStateTrace( + simgrid::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); } + /** @deprecated */ + XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_profile()") void setLatencyTrace( + simgrid::kernel::profile::Profile* profile) { set_latency_profile(profile); } +#endif }; } }