X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c7c5def2870e604025be03b866967c0c5e293afe..da78bba04a81c0fffc03f411ba16444b34dfae56:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 670f5022c9..e5cf824b38 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2018. 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. */ @@ -51,7 +51,7 @@ namespace s4u { * pure function or as an object. It is very simple with functions: * * @code{.cpp} - * #include "s4u/actor.hpp" + * #include * * // Declare the code of your worker * void worker() { @@ -69,7 +69,7 @@ namespace s4u { * The syntax is slightly more complicated, but not much. * * @code{.cpp} - * #include "s4u/actor.hpp" + * #include * * // Declare the class representing your actors * class Worker { @@ -129,8 +129,7 @@ namespace s4u { */ /** @brief Simulation Agent */ -XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable -{ +class XBT_PUBLIC Actor : public simgrid::xbt::Extendable { friend Exec; friend Mailbox; friend simgrid::simix::ActorImpl; @@ -156,8 +155,8 @@ public: Actor& operator=(Actor const&) = delete; // ***** Reference count ***** - friend XBT_PUBLIC(void) intrusive_ptr_add_ref(Actor * actor); - friend XBT_PUBLIC(void) intrusive_ptr_release(Actor * actor); + friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor); + friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor); // ***** Actor creation ***** /** Retrieve a reference to myself */ @@ -165,6 +164,8 @@ public: /** Signal to others that a new actor has been created **/ static simgrid::xbt::signal onCreation; + /** Signal indicating that the given actor is about to disappear */ + static simgrid::xbt::signal onDestruction; /** Create an actor using a function * @@ -202,6 +203,9 @@ public: /** This actor will be automatically terminated when the last non-daemon actor finishes **/ void daemonize(); + /** Returns whether or not this actor has been daemonized or not **/ + bool isDaemon(); + /** Retrieves the name of that actor as a C++ string */ const simgrid::xbt::string& getName() const; /** Retrieves the name of that actor as a C string */ @@ -210,11 +214,11 @@ public: s4u::Host* getHost(); /** Retrieves the PID of that actor * - * actor_id_t is an alias for unsigned long */ + * aid_t is an alias for long */ aid_t getPid(); /** Retrieves the PPID of that actor * - * actor_id_t is an alias for unsigned long */ + * aid_t is an alias for long */ aid_t getPpid(); /** Suspend an actor by suspending the task on which it was waiting for the completion. */ @@ -285,11 +289,11 @@ public: * @brief Static methods working on the current actor (see @ref s4u::Actor) */ namespace this_actor { -XBT_PUBLIC(bool) isMaestro(); +XBT_PUBLIC bool isMaestro(); /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */ -XBT_PUBLIC(void) sleep_for(double duration); -XBT_PUBLIC(void) sleep_until(double timeout); +XBT_PUBLIC void sleep_for(double duration); +XBT_PUBLIC void sleep_until(double timeout); template inline void sleep_for(std::chrono::duration duration) { @@ -310,76 +314,76 @@ XBT_ATTRIB_DEPRECATED_v320("Use sleep_for(): v3.20 will turn this warning into a } /** Block the actor, computing the given amount of flops */ -XBT_PUBLIC(void) execute(double flop); +XBT_PUBLIC void execute(double flop); /** Block the actor, computing the given amount of flops at the given priority. * An execution of priority 2 computes twice as fast as an execution at priority 1. */ -XBT_PUBLIC(void) execute(double flop, double priority); +XBT_PUBLIC void execute(double flop, double priority); -XBT_PUBLIC(void) parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount); -XBT_PUBLIC(void) -parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, double timeout); +XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount); +XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, + double timeout); -XBT_PUBLIC(ExecPtr) exec_init(double flops_amounts); -XBT_PUBLIC(ExecPtr) exec_async(double flops_amounts); +XBT_PUBLIC ExecPtr exec_init(double flops_amounts); +XBT_PUBLIC ExecPtr exec_async(double flops_amounts); /** Block the actor until it gets a message from the given mailbox. * * See \ref Comm for the full communication API (including non blocking communications). */ -XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void*) - recv(MailboxPtr chan); -XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void*) - recv(MailboxPtr chan, double timeout); -XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::recv_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr) +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC + void* recv(MailboxPtr chan); +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC + void* recv(MailboxPtr chan, double timeout); +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::recv_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC CommPtr irecv(MailboxPtr chan, void** data); /** Block the actor until it delivers a message of the given simulated size to the given mailbox * * See \ref Comm for the full communication API (including non blocking communications). */ -XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void) - send(MailboxPtr chan, void* payload, double simulatedSize); -XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void) - send(MailboxPtr chan, void* payload, double simulatedSize, double timeout); +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC + void send(MailboxPtr chan, void* payload, double simulatedSize); +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC + void send(MailboxPtr chan, void* payload, double simulatedSize, double timeout); -XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr) +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC CommPtr isend(MailboxPtr chan, void* payload, double simulatedSize); /** @brief Returns the actor ID of the current actor). */ -XBT_PUBLIC(aid_t) getPid(); +XBT_PUBLIC aid_t getPid(); /** @brief Returns the ancestor's actor ID of the current actor. */ -XBT_PUBLIC(aid_t) getPpid(); +XBT_PUBLIC aid_t getPpid(); /** @brief Returns the name of the current actor. */ -XBT_PUBLIC(std::string) getName(); +XBT_PUBLIC std::string getName(); /** @brief Returns the name of the current actor as a C string. */ -XBT_PUBLIC(const char*) getCname(); +XBT_PUBLIC const char* getCname(); /** @brief Returns the name of the host on which the actor is running. */ -XBT_PUBLIC(Host*) getHost(); +XBT_PUBLIC Host* getHost(); /** @brief Suspend the actor. */ -XBT_PUBLIC(void) suspend(); +XBT_PUBLIC void suspend(); /** @brief yield the actor. */ -XBT_PUBLIC(void) yield(); +XBT_PUBLIC void yield(); /** @brief Resume the actor. */ -XBT_PUBLIC(void) resume(); +XBT_PUBLIC void resume(); -XBT_PUBLIC(bool) isSuspended(); +XBT_PUBLIC bool isSuspended(); /** @brief kill the actor. */ -XBT_PUBLIC(void) kill(); +XBT_PUBLIC void kill(); /** @brief Add a function to the list of "on_exit" functions. */ -XBT_PUBLIC(void) onExit(int_f_pvoid_pvoid_t fun, void* data); +XBT_PUBLIC void onExit(int_f_pvoid_pvoid_t fun, void* data); /** @brief Migrate the actor to a new host. */ -XBT_PUBLIC(void) migrate(Host* new_host); +XBT_PUBLIC void migrate(Host* new_host); } /** @} */