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 <simgrid/link.h>
  10 #include <xbt/base.h>
  11 #include <xbt/signal.hpp>
  12
  13 #include <unordered_map>
  14
  15 /***********
  16  * Classes *
  17  ***********/
  18
  19 namespace simgrid {
  20 namespace surf {
  21 class NetworkAction;
  22 };
  23 namespace s4u {
  24 /** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */
  25 XBT_PUBLIC_CLASS Link
  26 {
  27   friend simgrid::surf::LinkImpl;
  28
  29 private:
  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_;
  35
  36 public:
  37   /** @brief Retrieve a link from its name */
  38   static Link* byName(const char* name);
  39
  40   /** @brief Get da name */
  41   const char* name();
  42
  43   /** @brief Get the bandwidth in bytes per second of current Link */
  44   double bandwidth();
  45
  46   /** @brief Get the latency in seconds of current Link */
  47   double latency();
  48
  49   /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX)
  50    */
  51   int sharingPolicy();
  52
  53   /** @brief Check if the Link is used */
  54   bool isUsed();
  55
  56   void turnOn();
  57   void turnOff();
  58
  59   void* getData();
  60   void setData(void* d);
  61
  62   void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain
  63                                              boolean values. */
  64   void setBandwidthTrace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to
  65                                                   external load). Trace must contain percentages (value between 0 and 1). */
  66   void setLatencyTrace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to
  67                                                external load). Trace must contain absolute values */
  68
  69   /* The signals */
  70   /** @brief Callback signal fired when a new Link is created */
  71   static simgrid::xbt::signal<void(s4u::Link&)> onCreation;
  72
  73   /** @brief Callback signal fired when a Link is destroyed */
  74   static simgrid::xbt::signal<void(s4u::Link&)> onDestruction;
  75
  76   /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
  77   static simgrid::xbt::signal<void(s4u::Link&)> onStateChange;
  78
  79   /** @brief Callback signal fired when a communication starts */
  80   static simgrid::xbt::signal<void(surf::NetworkAction*, s4u::Host* src, s4u::Host* dst)> onCommunicate;
  81
  82   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
  83   static simgrid::xbt::signal<void(surf::NetworkAction*)> onCommunicationStateChange;
  84 };
  85 }
  86 }
  87
  88 #endif /* SURF_NETWORK_INTERFACE_HPP_ */