Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[DOC] Fixed even more errors.
[simgrid.git] / src / surf / network_interface.hpp
index 2226805..6696895 100644 (file)
@@ -33,35 +33,14 @@ class NetworkAction;
  * Callbacks *
  *************/
 
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emits the callbacks after Link creation
- * @details Callback functions have the following signature: `void(Link*)`
- */
-XBT_PUBLIC_DATA(simgrid::surf::signal<void(simgrid::surf::Link*)>) networkLinkCreatedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emits the callbacks after Link destruction
- * @details Callback functions have the following signature: `void(Link*)`
- */
-XBT_PUBLIC_DATA(simgrid::surf::signal<void(simgrid::surf::Link*)>) networkLinkDestructedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emits the callbacks after Link State changed
- * @details Callback functions have the following signature: `void(LinkAction *action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
- */
-XBT_PUBLIC_DATA(simgrid::surf::signal<void(simgrid::surf::Link*, e_surf_resource_state_t, e_surf_resource_state_t)>) networkLinkStateChangedCallbacks;
 
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emits the callbacks after NetworkAction State changed
- * @details Callback functions have the following signature: `void(NetworkAction *action, e_surf_action_state_t old, e_surf_action_state_t current)`
- */
-XBT_PUBLIC_DATA(simgrid::surf::signal<void(simgrid::surf::NetworkAction*, e_surf_action_state_t, e_surf_action_state_t)>) networkActionStateChangedCallbacks;
+/** @brief Callback signal fired when the state of a NetworkAction changes
+ *  Signature: `void(NetworkAction *action, e_surf_action_state_t old, e_surf_action_state_t current)` */
+XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::NetworkAction*, e_surf_action_state_t, e_surf_action_state_t)>) networkActionStateChangedCallbacks;
 
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emits the callbacks after communication created
- * @details Callback functions have the following signature: `void(NetworkAction *action, RoutingEdge *src, RoutingEdge *dst, double size, double rate)`
- */
-XBT_PUBLIC_DATA(simgrid::surf::signal<void(simgrid::surf::NetworkAction*, simgrid::surf::RoutingEdge *src, simgrid::surf::RoutingEdge *dst, double size, double rate)>) networkCommunicateCallbacks;
+/** @brief Callback signal fired when a NetworkAction is created (when a communication starts)
+ *  Signature: `void(NetworkAction *action, RoutingEdge *src, RoutingEdge *dst, double size, double rate)` */
+XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::NetworkAction*, simgrid::surf::NetCard *src, simgrid::surf::NetCard *dst, double size, double rate)>) networkCommunicateCallbacks;
 
 }
 }
@@ -71,8 +50,6 @@ XBT_PUBLIC_DATA(simgrid::surf::signal<void(simgrid::surf::NetworkAction*, simgri
  *********/
 XBT_PUBLIC(void) netlink_parse_init(sg_platf_link_cbarg_t link);
 
-XBT_PUBLIC(void) net_add_traces();
-
 /*********
  * Model *
  *********/
@@ -107,7 +84,7 @@ public:
    * @param bw_trace The trace associated to the Link bandwidth
    * @param lat_initial The initial latency of the Link in seconds
    * @param lat_trace The trace associated to the Link latency
-   * @param state_initial The initial Link (state)[e_surf_resource_state_t]
+   * @param initiallyOn The initial Link (state)[e_surf_resource_state_t]
    * @param state_trace The trace associated to the Link (state)[e_surf_resource_state_t]
    * @param policy The sharing policy of the Link
    * @param properties Dictionary of properties associated to this Resource
@@ -118,7 +95,7 @@ public:
                                    tmgr_trace_t bw_trace,
                                    double lat_initial,
                                    tmgr_trace_t lat_trace,
-                                   e_surf_resource_state_t state_initial,
+                                   int initiallyOn,
                                    tmgr_trace_t state_trace,
                                    e_surf_link_sharing_policy_t policy,
                                    xbt_dict_t properties)=0;
@@ -135,7 +112,7 @@ public:
    * unlimited.
    * @return The action representing the communication
    */
-  virtual Action *communicate(RoutingEdge *src, RoutingEdge *dst,
+  virtual Action *communicate(NetCard *src, NetCard *dst,
                                           double size, double rate)=0;
 
   /** @brief Function pointer to the function to use to solve the lmm_system_t
@@ -188,7 +165,9 @@ public:
   * @brief SURF network link interface class
   * @details A Link represents the link between two [hosts](\ref Host)
   */
-class Link : public simgrid::surf::Resource, public simgrid::surf::PropertyHolder {
+class Link :
+               public simgrid::surf::Resource,
+               public simgrid::surf::PropertyHolder {
 public:
   /**
    * @brief Link constructor
@@ -214,8 +193,28 @@ public:
               tmgr_history_t history,
               tmgr_trace_t state_trace);
 
-  /** @brief Link destructor */
+  /* Link destruction logic */
+  /**************************/
+protected:
   ~Link();
+public:
+       void destroy(); // Must be called instead of the destructor
+private:
+       bool currentlyDestroying_ = false;
+
+public:
+  /** @brief Callback signal fired when a new Link is created.
+   *  Signature: void(Link*) */
+  static simgrid::xbt::signal<void(simgrid::surf::Link*)> onCreation;
+
+  /** @brief Callback signal fired when a Link is destroyed.
+   *  Signature: void(Link*) */
+  static simgrid::xbt::signal<void(simgrid::surf::Link*)> onDestruction;
+
+  /** @brief Callback signal fired when the state of a Link changes
+   *  Signature: `void(LinkAction *action, int previouslyOn, int currentlyOn)` */
+  static simgrid::xbt::signal<void(simgrid::surf::Link*, int, int)> onStateChange;
+
 
   /** @brief Get the bandwidth in bytes per second of current Link */
   virtual double getBandwidth();
@@ -229,13 +228,14 @@ public:
   /** @brief Update the latency in seconds of current Link */
   virtual void updateLatency(double value, double date=surf_get_clock())=0;
 
-  /** @brief The sharing policy is a @{link #e_surf_link_sharing_policy_t} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */
+  /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */
   virtual int sharingPolicy();
 
   /** @brief Check if the Link is used */
-  bool isUsed();
+  bool isUsed() override;
 
-  void setState(e_surf_resource_state_t state);
+  void turnOn() override;
+  void turnOff() override;
 
   /* Using this object with the public part of
     model does not make sense */
@@ -258,7 +258,7 @@ private:
   static boost::unordered_map<std::string, Link *> *links;
 public:
   static Link *byName(const char* name);
-  static int linksAmount();
+  static int linksCount();
   static Link **linksList();
   static void linksExit();
 };