Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
improve the doc of Actor::on_destruction()
authorMartin Quinson <martin.quinson@loria.fr>
Thu, 20 Sep 2018 07:35:53 +0000 (09:35 +0200)
committerMartin Quinson <martin.quinson@loria.fr>
Thu, 20 Sep 2018 07:39:08 +0000 (09:39 +0200)
Explain the difference with this_actor::on_exit()
This fixes https://github.com/simgrid/simgrid/issues/289

ChangeLog
include/simgrid/s4u/Actor.hpp

index 3438268..a39a689 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -40,6 +40,7 @@ Fixed bugs:
  - #286: Paj√© traces are not exposing the number of cores
  - #287: Command-line parsing should stop when encountering '--'
  - #288: MPI_Init(NULL, NULL)
+ - #289: Improve documentation of Actor::on_destruction and this_actor::on_exit()
  - #296: DTD too permissive
 
 ----------------------------------------------------------------------------
index dcab10e..a951265 100644 (file)
@@ -158,7 +158,10 @@ public:
   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_start;
   /** Signal to others that an actor is has been migrated to another host **/
   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_end;
-  /** Signal indicating that the given actor is about to disappear */
+  /** Signal indicating that an actor is about to disappear.
+   *  This signal is fired for any dying actor, which is mostly useful when
+   *  designing plugins and extensions. If you want to register to the
+   *  termination of a given actor, use this_actor::on_exit() instead.*/
   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_destruction;
 
   /** Create an actor from a std::function<void()>