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