1 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include <simgrid/link.h>
11 #include <xbt/signal.hpp>
14 #include <unordered_map>
25 /** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */
28 friend simgrid::surf::LinkImpl;
30 // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
31 explicit Link(surf::LinkImpl* pimpl) : pimpl_(pimpl) {}
32 virtual ~Link() = default;
33 // The private implementation, that never changes
34 surf::LinkImpl* const pimpl_;
37 /** @brief Retrieve a link from its name */
38 static Link* byName(const char* name);
40 /** @brief Retrieves the name of that link as a C++ string */
41 const std::string& getName() const;
42 /** @brief Retrieves the name of that link as a C string */
43 const char* getCname() const;
45 /** @brief Get the bandwidth in bytes per second of current Link */
48 /** @brief Get the latency in seconds of current Link */
51 /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX)
55 /** @brief Check if the Link is used */
62 void setData(void* d);
64 void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain
66 void setBandwidthTrace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to
67 external load). Trace must contain percentages (value between 0 and 1). */
68 void setLatencyTrace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to
69 external load). Trace must contain absolute values */
72 /** @brief Callback signal fired when a new Link is created */
73 static simgrid::xbt::signal<void(s4u::Link&)> onCreation;
75 /** @brief Callback signal fired when a Link is destroyed */
76 static simgrid::xbt::signal<void(s4u::Link&)> onDestruction;
78 /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
79 static simgrid::xbt::signal<void(s4u::Link&)> onStateChange;
81 /** @brief Callback signal fired when a communication starts */
82 static simgrid::xbt::signal<void(surf::NetworkAction*, s4u::Host* src, s4u::Host* dst)> onCommunicate;
84 /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
85 static simgrid::xbt::signal<void(surf::NetworkAction*)> onCommunicationStateChange;
87 XBT_ATTRIB_DEPRECATED_v321("Use getCname(): v3.21 will turn this warning into an error.") const char* name();
92 #endif /* SURF_NETWORK_INTERFACE_HPP_ */