X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/537b55f6d4bf8ede2526c2bd6cf79bd38b465dac..73b559c7c9341d9d98fc8f0523be23ba9d676fa6:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 09e3df6803..fd9a6a4751 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -18,7 +18,7 @@ namespace simgrid { namespace s4u { -/** @ingroup s4u_api +/** * * An actor is an independent stream of execution in your distributed application. * @@ -121,21 +121,14 @@ namespace s4u { /** @brief Simulation Agent */ class XBT_PUBLIC Actor : public simgrid::xbt::Extendable { +#ifndef DOXYGEN friend Exec; friend Mailbox; friend simgrid::kernel::actor::ActorImpl; friend simgrid::kernel::activity::MailboxImpl; +#endif kernel::actor::ActorImpl* pimpl_ = nullptr; - /** Wrap a (possibly non-copyable) single-use task into a `std::function` */ - template - static std::function wrap_task(F f, Args... args) - { - typedef decltype(f(std::move(args)...)) R; - auto task = std::make_shared>(simgrid::xbt::make_task(std::move(f), std::move(args)...)); - return [task] { (*task)(); }; - } - explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {} public: @@ -169,31 +162,30 @@ public: /** Signal indicating that the given actor is about to disappear */ static simgrid::xbt::signal on_destruction; - /** Create an actor using a function + /** Create an actor from a std::function * * If the actor is restarted, the actor has a fresh copy of the function. */ static ActorPtr create(std::string name, s4u::Host* host, std::function code); - static ActorPtr create(std::string name, s4u::Host* host, std::function*)> code, - std::vector* args) + /** Create an actor from a std::function + * + * If the actor is restarted, the actor has a fresh copy of the function. + */ + template static ActorPtr create(std::string name, s4u::Host* host, F code) { - return create(name, host, [code](std::vector* args) { code(args); }, args); + return create(name, host, std::function(std::move(code))); } - /** Create an actor using code + /** Create an actor using a callable thing and its arguments. * - * Using this constructor, move-only type can be used. The consequence is - * that we cannot copy the value and restart the actor in its initial - * state. In order to use auto-restart, an explicit `function` must be passed - * instead. - */ + * Note that the arguments will be copied, so move-only parameters are forbidden */ template ::type> static ActorPtr create(std::string name, s4u::Host* host, F code, Args... args) { - return create(name, host, wrap_task(std::move(code), std::move(args)...)); + return create(name, host, std::bind(std::move(code), std::move(args)...)); } // Create actor from function name: @@ -245,6 +237,15 @@ public: /** Retrieves the time at which that actor will be killed (or -1 if not set) */ double get_kill_time(); + /** @brief Moves the actor to another host + * + * If the actor is currently blocked on an execution activity, the activity is also + * migrated to the new host. If it's blocked on another kind of activity, an error is + * raised as the mandated code is not written yet. Please report that bug if you need it. + * + * Asynchronous activities started by the actor are not migrated automatically, so you have + * to take care of this yourself (only you knows which ones should be migrated). + */ void migrate(Host * new_host); /** Ask the actor to die. @@ -262,7 +263,7 @@ public: /** Retrieves the actor that have the given PID (or nullptr if not existing) */ static ActorPtr by_pid(aid_t pid); - /** @brief Wait for the actor to finish. + /** Wait for the actor to finish. * * This blocks the calling actor until the actor on which we call join() is terminated */ @@ -282,6 +283,7 @@ public: const char* get_property(std::string key); void set_property(std::string key, std::string value); +#ifndef DOXYGEN /** @deprecated See Actor::create() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor( const char* name, s4u::Host* host, std::function code) @@ -373,6 +375,7 @@ public: { set_property(key, value); } +#endif }; /** @ingroup s4u_api @@ -439,15 +442,18 @@ XBT_PUBLIC bool is_suspended(); /** @brief kill the actor. */ XBT_PUBLIC void exit(); -/** @deprecated Please use std::function for first parameter */ -XBT_ATTRIB_DEPRECATED_v323("Please use std::function for first parameter.") XBT_PUBLIC - void on_exit(int_f_pvoid_pvoid_t fun, void* data); /** @brief Add a function to the list of "on_exit" functions. */ XBT_PUBLIC void on_exit(std::function fun, void* data); /** @brief Migrate the actor to a new host. */ XBT_PUBLIC void migrate(Host* new_host); +/** @} */ + +#ifndef DOXYGEN +/** @deprecated Please use std::function for first parameter */ +XBT_ATTRIB_DEPRECATED_v323("Please use std::function for first parameter.") XBT_PUBLIC + void on_exit(int_f_pvoid_pvoid_t fun, void* data); /** @deprecated See this_actor::get_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_name()") XBT_PUBLIC std::string getName(); /** @deprecated See this_actor::get_cname() */ @@ -466,9 +472,9 @@ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_suspended()") XBT_PUBLIC b 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() */ XBT_ATTRIB_DEPRECATED_v324("Please use this_actor::exit()") XBT_PUBLIC void kill(); +#endif } -/** @} */ }} // namespace simgrid::s4u