X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2f37dba04ea44bc979a25129f10b18797b6fec1e..cdac506670725ae4fe40b3b1a31ceeb9488ce53a:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 3167cfd973..f0c41432db 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2019. 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. */ @@ -211,14 +211,12 @@ public: /** 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. */ + /** Suspend an actor, that is blocked until resume()ed by another actor */ void suspend(); - /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */ + /** Resume an actor that was previously suspend()ed */ void resume(); - void yield(); - /** Returns true if the actor is suspended. */ bool is_suspended(); @@ -260,21 +258,25 @@ public: */ void kill(); - /** Kill an actor from its ID */ - static void kill(aid_t pid); - /** Retrieves the actor that have the given PID (or nullptr if not existing) */ static ActorPtr by_pid(aid_t pid); /** Wait for the actor to finish. * - * This blocks the calling actor until the actor on which we call join() is terminated + * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is + * blocked until bob terminates. */ void join(); + + /** Wait for the actor to finish, or for the timeout to elapse. + * + * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is + * blocked until bob terminates. + */ void join(double timeout); Actor* restart(); - /** Ask kindly to all actors to die. Only the issuer will survive. */ + /** Kill all actors (but the issuer). Being killed is not something that actors can delay or avoid. */ static void kill_all(); /** Returns the internal implementation of this actor */ @@ -287,6 +289,8 @@ public: void set_property(std::string key, std::string value); #ifndef DOXYGEN + XBT_ATTRIB_DEPRECATED_v325("Please use Actor::by_pid(pid).kill() instead") static void kill(aid_t pid); + /** @deprecated See Actor::create() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor( const char* name, s4u::Host* host, std::function code) @@ -387,8 +391,9 @@ namespace this_actor { XBT_PUBLIC bool is_maestro(); -/** Block the actor sleeping for that amount of seconds (may throws hostFailure) */ +/** Block the current actor sleeping for that amount of seconds (may throw hostFailure) */ XBT_PUBLIC void sleep_for(double duration); +/** Block the current actor sleeping until the specified timestamp (may throw hostFailure) */ XBT_PUBLIC void sleep_until(double timeout); template inline void sleep_for(std::chrono::duration duration) @@ -403,10 +408,10 @@ template inline void sleep_until(const SimulationTimePoint hosts, std::vector bytes_amounts); /** \rst - * Block the actor until the built :ref:`parallel execution ` completes, or until the timeout. - * \endrst + * Block the current actor until the built :ref:`parallel execution ` completes, or until the + * timeout. \endrst */ XBT_PUBLIC void parallel_execute(std::vector hosts, std::vector flops_amounts, std::vector bytes_amounts, double timeout); @@ -496,27 +501,25 @@ XBT_PUBLIC std::string get_name(); /** @brief Returns the name of the current actor as a C string. */ XBT_PUBLIC const char* get_cname(); -/** @brief Returns the name of the host on which the actor is running. */ +/** @brief Returns the name of the host on which the curret actor is running. */ XBT_PUBLIC Host* get_host(); -/** @brief Suspend the actor. */ +/** @brief Suspend the current actor, that is blocked until resume()ed by another actor. */ XBT_PUBLIC void suspend(); -/** @brief Yield the actor. */ +/** @brief Yield the current actor. */ XBT_PUBLIC void yield(); -/** @brief Resume the actor. */ +/** @brief Resume the current actor, that was suspend()ed previously. */ XBT_PUBLIC void resume(); -XBT_PUBLIC bool is_suspended(); - -/** @brief kill the actor. */ +/** @brief kill the current actor. */ XBT_PUBLIC void exit(); -/** @brief Add a function to the list of "on_exit" functions. */ +/** @brief Add a function to the list of "on_exit" functions of the current actor. */ XBT_PUBLIC void on_exit(std::function fun, void* data); -/** @brief Migrate the actor to a new host. */ +/** @brief Migrate the current actor to a new host. */ XBT_PUBLIC void migrate(Host* new_host); /** @} */ @@ -537,8 +540,6 @@ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_pid()") XBT_PUBLIC aid_t XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_ppid()") XBT_PUBLIC aid_t getPpid(); /** @deprecated See this_actor::get_host() */ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_host()") XBT_PUBLIC Host* getHost(); -/** @deprecated See this_actor::is_suspended() */ -XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_suspended()") XBT_PUBLIC bool isSuspended(); /** @deprecated See this_actor::on_exit() */ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::on_exit()") XBT_PUBLIC void onExit(int_f_pvoid_pvoid_t fun, void* data); /** @deprecated See this_actor::exit() */