Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
align the Link callbacks with the ones of Host
[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/signal.hpp"
14
15 #include "simgrid/link.h"
16
17 /***********
18  * Classes *
19  ***********/
20
21 namespace simgrid {
22 namespace surf {
23 class NetworkAction;
24 class Action;
25 };
26 namespace s4u {
27 /** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */
28 class Link {
29   friend simgrid::surf::LinkImpl;
30
31 private:
32   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
33   explicit Link(surf::LinkImpl* pimpl) : pimpl_(pimpl) {}
34   virtual ~Link() = default;
35   // The private implementation, that never changes
36   surf::LinkImpl* const pimpl_;
37
38 public:
39   /** @brief Retrieve a link from its name */
40   static Link* byName(const char* name);
41
42   /** @brief Get da name */
43   const char* name();
44
45   /** @brief Get the bandwidth in bytes per second of current Link */
46   double bandwidth();
47
48   /** @brief Get the latency in seconds of current Link */
49   double latency();
50
51   /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX)
52    */
53   int sharingPolicy();
54
55   /** @brief Check if the Link is used */
56   bool isUsed();
57
58   void turnOn();
59   void turnOff();
60
61   void* getData();
62   void setData(void* d);
63
64   void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain
65                                              boolean values. */
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 */
70
71   /* The signals */
72   /** @brief Callback signal fired when a new Link is created */
73   static simgrid::xbt::signal<void(s4u::Link&)> onCreation;
74
75   /** @brief Callback signal fired when a Link is destroyed */
76   static simgrid::xbt::signal<void(s4u::Link&)> onDestruction;
77
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;
80
81   /** @brief Callback signal fired when a communication starts */
82   static simgrid::xbt::signal<void(surf::NetworkAction*, s4u::Host* src, s4u::Host* dst)> onCommunicate;
83
84   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
85   static simgrid::xbt::signal<void(surf::NetworkAction*)> onCommunicationStateChange;
86 };
87 }
88 }
89
90 #endif /* SURF_NETWORK_INTERFACE_HPP_ */