Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
easily please sonar
[simgrid.git] / include / simgrid / s4u / Link.hpp
1 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #ifndef S4U_LINK_HPP_
7 #define S4U_LINK_HPP_
8
9 #include <xbt/base.h>
10
11 #include <unordered_map>
12
13 #include "xbt/dict.h"
14 #include "xbt/fifo.h"
15
16 #include "simgrid/link.h"
17
18 /***********
19  * Classes *
20  ***********/
21
22 namespace simgrid {
23 namespace s4u {
24 /** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */
25 class Link {
26   friend simgrid::surf::LinkImpl;
27
28 private:
29   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
30   explicit Link(surf::LinkImpl* pimpl) : pimpl_(pimpl) {}
31   virtual ~Link() = default;
32   // The private implementation, that never changes
33   surf::LinkImpl* const pimpl_;
34
35 public:
36   /** @brief Retrieve a link from its name */
37   static Link* byName(const char* name);
38
39   /** @brief Get da name */
40   const char* name();
41
42   /** @brief Get the bandwidth in bytes per second of current Link */
43   double bandwidth();
44
45   /** @brief Get the latency in seconds of current Link */
46   double latency();
47
48   /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX)
49    */
50   int sharingPolicy();
51
52   /** @brief Check if the Link is used */
53   bool isUsed();
54
55   void turnOn();
56   void turnOff();
57
58   void* getData();
59   void setData(void* d);
60
61   void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain
62                                              boolean values. */
63   void setBandwidthTrace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to
64                                                   external load). Trace must contain percentages (value between 0 and 1). */
65   void setLatencyTrace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to
66                                                external load). Trace must contain absolute values */
67 };
68 }
69 }
70
71 #endif /* SURF_NETWORK_INTERFACE_HPP_ */