*/
template <class F> static ActorPtr create(std::string name, s4u::Host* host, F code)
{
- return create(name, host, std::function<void()>(std::move(code)));
+ return create(std::move(name), host, std::function<void()>(std::move(code)));
}
/** Create an actor using a callable thing and its arguments.
typename = typename std::result_of<F(Args...)>::type>
static ActorPtr create(std::string name, s4u::Host* host, F code, Args... args)
{
- return create(name, host, std::bind(std::move(code), std::move(args)...));
+ return create(std::move(name), host, std::bind(std::move(code), std::move(args)...));
}
// Create actor from function name:
- static ActorPtr create(std::string name, s4u::Host* host, std::string function, std::vector<std::string> args);
+ static ActorPtr create(std::string name, s4u::Host* host, const std::string& function, std::vector<std::string> args);
// ***** Methods *****
/** This actor will be automatically terminated when the last non-daemon actor finishes **/
* 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.
+ *
+ * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
+ * It will be set to true if the actor was killed or failed because of an exception,
+ * while it will remain to false if the actor terminated gracefully.
*/
- void on_exit(std::function<void(int, void*)> fun, void* data);
+ void on_exit(std::function<void(bool /*failed*/)> fun);
/** Sets the time at which that actor should be killed */
void set_kill_time(double time);
/** Retrieve the property value (or nullptr if not set) */
std::unordered_map<std::string, std::string>*
get_properties(); // FIXME: do not export the map, but only the keys or something
- const char* get_property(std::string key);
- void set_property(std::string key, std::string value);
+ const char* get_property(const std::string& key);
+ void set_property(const std::string& key, std::string value);
#ifndef DOXYGEN
+ XBT_ATTRIB_DEPRECATED_v325("Please use Actor::on_exit(fun) instead") void on_exit(std::function<void(int, void*)> fun,
+ void* data);
+
XBT_ATTRIB_DEPRECATED_v325("Please use Actor::by_pid(pid).kill() instead") static void kill(aid_t pid);
/** @deprecated See Actor::create() */
/** @deprecated See Actor::on_exit() */
XBT_ATTRIB_DEPRECATED_v323("Please use Actor::on_exit()") void onExit(int_f_pvoid_pvoid_t fun, void* data)
{
- on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
+ on_exit([fun, data](bool a) { fun((void*)(uintptr_t)a, data); });
}
/** @deprecated See Actor::set_kill_time() */
XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_kill_time()") void setKillTime(double time) { set_kill_time(time); }
*
* \endrst
*/
-XBT_PUBLIC void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
- std::vector<double> bytes_amounts);
+XBT_PUBLIC void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
+ const std::vector<double>& bytes_amounts);
/** \rst
* Block the current actor until the built :ref:`parallel execution <API_s4u_parallel_execute>` completes, or until the
* timeout. \endrst
*/
-XBT_PUBLIC void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
- std::vector<double> bytes_amounts, double timeout);
+XBT_PUBLIC void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
+ const std::vector<double>& bytes_amounts, double timeout);
#ifndef DOXYGEN
XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
- void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount);
+ void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount,
+ const double* bytes_amount);
XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
- void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount,
- double timeout);
+ void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount,
+ const double* bytes_amount, double timeout);
#endif
XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
/** @brief kill the current actor. */
XBT_PUBLIC void exit();
-/** @brief Add a function to the list of "on_exit" functions of the current actor. */
-XBT_PUBLIC void on_exit(std::function<void(int, void*)> fun, void* data);
+/** @brief Add a function to the list of "on_exit" functions of 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.
+ *
+ * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
+ * It will be set to true if the actor was killed or failed because of an exception,
+ * while it will remain to false if the actor terminated gracefully.
+ */
+
+XBT_PUBLIC void on_exit(std::function<void(bool)> fun);
/** @brief Migrate the current actor to a new host. */
XBT_PUBLIC void migrate(Host* new_host);
/** @} */
#ifndef DOXYGEN
+XBT_ATTRIB_DEPRECATED_v325("Please use std::function<void(bool)> for first parameter.") XBT_PUBLIC
+ void on_exit(std::function<void(int, void*)> fun, void* data);
+
/** @deprecated Please use std::function<void(int, void*)> for first parameter */
-XBT_ATTRIB_DEPRECATED_v323("Please use std::function<void(int, void*)> for first parameter.") XBT_PUBLIC
+XBT_ATTRIB_DEPRECATED_v323("Please use std::function<void(bool)> 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();
