Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
small improvments to the s4u_actor doc
[simgrid.git] / include / simgrid / s4u / actor.hpp
index 24728db..fc067f1 100644 (file)
@@ -32,8 +32,6 @@ namespace s4u {
  * of this standard</a> may help to understand the philosophy of the S4U
  * Actors. 
  * 
- * (back to the @ref s4u_api "S4U documentation")
- * 
  * @section s4u_actor_def Defining the skeleton of an Actor
  * 
  * %As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
@@ -41,6 +39,8 @@ namespace s4u {
  * pure function or as an object. It is very simple with functions:
  * 
  * @code{.cpp}
+ * #include "s4u/actor.hpp"
+ * 
  * // Declare the code of your worker
  * void worker() {
  *   printf("Hello s4u");
@@ -48,7 +48,8 @@ namespace s4u {
  * };
  * 
  * // From your main or from another actor, create your actor on the host Jupiter
- * new Actor("worker", simgrid::s4u::Host::by_name("Jupiter"), worker);
+ * // The following line actually creates a new actor, even if there is no "new". 
+ * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
  * @endcode
  * 
  * But some people prefer to encapsulate their actors in classes and
@@ -68,7 +69,7 @@ namespace s4u {
  * };
  * 
  * // From your main or from another actor, create your actor. Note the () after Worker
- * new Actor("worker", simgrid::s4u::Host::by_name("Jupiter"), Worker());
+ * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
  * @endcode
  * 
  * @section s4u_actor_flesh Fleshing your actor
@@ -117,15 +118,38 @@ namespace s4u {
    
 /** @brief Simulation Agent (see \ref s4u_actor)*/
 XBT_PUBLIC_CLASS Actor {
-  explicit Actor(smx_process_t smx_proc);
 public:
+  Actor() : pimpl_(nullptr) {}
+  Actor(smx_process_t smx_proc) :
+    pimpl_(SIMIX_process_ref(smx_proc)) {}
+  ~Actor()
+  {
+    SIMIX_process_unref(pimpl_);
+  }
+
+  // Copy+move (with the copy-and-swap idiom):
+  Actor(Actor const& actor) : pimpl_(SIMIX_process_ref(actor.pimpl_)) {}
+  friend void swap(Actor& first, Actor& second)
+  {
+    using std::swap;
+    swap(first.pimpl_, second.pimpl_);
+  }
+  Actor& operator=(Actor actor)
+  {
+    swap(*this, actor);
+    return *this;
+  }
+  Actor(Actor&& actor) : pimpl_(nullptr)
+  {
+    swap(*this, actor);
+  }
+
   Actor(const char* name, s4u::Host *host, double killTime, std::function<void()> code);
   Actor(const char* name, s4u::Host *host, std::function<void()> code)
     : Actor(name, host, -1, std::move(code)) {};
   template<class C>
   Actor(const char* name, s4u::Host *host, C code)
     : Actor(name, host, -1, std::function<void()>(std::move(code))) {}
-  ~Actor();
 
   /** Retrieves the actor that have the given PID (or NULL if not existing) */
   //static Actor *byPid(int pid); not implemented
@@ -163,11 +187,6 @@ public:
   /** Ask kindly to all actors to die. Only the issuer will survive. */
   static void killAll();
 
-protected:
-  smx_process_t getInferior()
-  {
-    return pimpl_;
-  }
 private:
   smx_process_t pimpl_ = nullptr;
 };