Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
various useless cosmetics
[simgrid.git] / include / simgrid / s4u / Link.hpp
index f554dfe..81c3929 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
  ***********/
 
 namespace simgrid {
-namespace surf {
-class NetworkAction;
-};
 namespace s4u {
 /** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */
-XBT_PUBLIC_CLASS Link : public simgrid::xbt::Extendable<Link>
-{
-  friend simgrid::surf::LinkImpl;
+class XBT_PUBLIC Link : public simgrid::xbt::Extendable<Link> {
+  friend simgrid::kernel::resource::LinkImpl;
 
   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
-  explicit Link(surf::LinkImpl* pimpl) : pimpl_(pimpl) {}
+  explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
   virtual ~Link() = default;
   // The private implementation, that never changes
-  surf::LinkImpl* const pimpl_;
+  kernel::resource::LinkImpl* const pimpl_;
 
 public:
   /** @brief Retrieve a link from its name */
-  static Link* byName(const char* name);
+  static Link* by_name(const char* name);
 
   /** @brief Retrieves the name of that link as a C++ string */
-  const std::string& getName() const;
+  const std::string& get_name() const;
   /** @brief Retrieves the name of that link as a C string */
-  const char* getCname() const;
+  const char* get_cname() const;
+
+  XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); }
 
   /** @brief Get the bandwidth in bytes per second of current Link */
   double bandwidth();
@@ -48,7 +48,7 @@ public:
   /** @brief Get the latency in seconds of current Link */
   double latency();
 
-  /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (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: SPLITDUPLEX)
    */
   int sharingPolicy();
 
@@ -85,12 +85,12 @@ public:
   static simgrid::xbt::signal<void(s4u::Link&)> onStateChange;
 
   /** @brief Callback signal fired when a communication starts */
-  static simgrid::xbt::signal<void(surf::NetworkAction*, s4u::Host* src, s4u::Host* dst)> onCommunicate;
+  static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, s4u::Host* src, s4u::Host* dst)> onCommunicate;
 
   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
-  static simgrid::xbt::signal<void(surf::NetworkAction*)> onCommunicationStateChange;
+  static simgrid::xbt::signal<void(kernel::resource::NetworkAction*)> onCommunicationStateChange;
 
-  XBT_ATTRIB_DEPRECATED_v321("Use getCname(): v3.21 will turn this warning into an error.") const char* name();
+  XBT_ATTRIB_DEPRECATED_v321("Use get_cname(): v3.21 will turn this warning into an error.") const char* name();
 };
 }
 }