X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/977ce74cee777641db27a02631b20bd3ac793e8b..2f37dba04ea44bc979a25129f10b18797b6fec1e:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 926cefb276..3167cfd973 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -206,13 +206,9 @@ public: const char* get_cname() const; /** Retrieves the host on which that actor is running */ s4u::Host* get_host(); - /** Retrieves the PID of that actor - * - * aid_t is an alias for long */ + /** Retrieves the actor ID of that actor */ aid_t get_pid() const; - /** Retrieves the PPID of that actor - * - * aid_t is an alias for long */ + /** Retrieves the actor ID of that actor's creator */ aid_t get_ppid() const; /** Suspend an actor by suspending the task on which it was waiting for the completion. */ @@ -231,6 +227,10 @@ public: /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions * executed when your actor is killed. You should use them to free the data used by your actor. + * + * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot + * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are + * blocking functions forbidden in this setting, but also modifications to the global state. */ void on_exit(std::function fun, void* data); @@ -374,7 +374,7 @@ public: return res; } /** @deprecated See Actor::get_properties() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") void setProperty(const char* key, const char* value) + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_property()") void setProperty(const char* key, const char* value) { set_property(key, value); } @@ -485,7 +485,7 @@ XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC XBT_PUBLIC ExecPtr exec_init(double flops_amounts); XBT_PUBLIC ExecPtr exec_async(double flops_amounts); -/** @brief Returns the actor ID of the current actor). */ +/** @brief Returns the actor ID of the current actor. */ XBT_PUBLIC aid_t get_pid(); /** @brief Returns the ancestor's actor ID of the current actor. */ @@ -502,7 +502,7 @@ XBT_PUBLIC Host* get_host(); /** @brief Suspend the actor. */ XBT_PUBLIC void suspend(); -/** @brief yield the actor. */ +/** @brief Yield the actor. */ XBT_PUBLIC void yield(); /** @brief Resume the actor. */