From: Fred Suter Date: Fri, 2 Jun 2023 21:17:22 +0000 (-0400) Subject: [no-ci] precise which methods of the Actor class are static X-Git-Tag: v3.34~72 X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/916422155091e4e7e0f463cec933b88fed642e8a [no-ci] precise which methods of the Actor class are static --- diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index e4aca9d7ac..f3af5b9d41 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -209,7 +209,9 @@ public: int get_refcount() const; // ***** Actor creation ***** - /** Retrieve a reference to myself */ + /** \static + * Retrieve a reference to myself + */ static Actor* self(); private: @@ -230,25 +232,25 @@ private: xbt::signal on_this_destruction; public: - /** Add a callback fired when a new actor has been created **/ + /** \static Add a callback fired when a new actor has been created **/ static void on_creation_cb(const std::function& cb) { on_creation.connect(cb); } - /** Add a callback fired when any actor is suspended (right before the suspend) **/ + /** \static Add a callback fired when any actor is suspended (right before the suspend) **/ static void on_suspend_cb(const std::function& cb) { on_suspend.connect(cb); } /** Add a callback fired when this specific actor is suspended (right before the suspend) **/ void on_this_suspend_cb(const std::function& cb) { on_this_suspend.connect(cb); } - /** Add a callback fired when any actor is resumed (right before the resume) **/ + /** \static Add a callback fired when any actor is resumed (right before the resume) **/ static void on_resume_cb(const std::function& cb) { on_resume.connect(cb); } - /** Add a callback fired when any actor is resumed (right before the resume) **/ + /** Add a callback fired when this specific actor is resumed (right before the resume) **/ void on_this_resume_cb(const std::function& cb) { on_this_resume.connect(cb); } - /** Add a callback fired when any actor starts sleeping **/ + /** \static Add a callback fired when any actor starts sleeping **/ static void on_sleep_cb(const std::function& cb) { on_sleep.connect(cb); } /** Add a callback fired when this specific actor starts sleeping **/ void on_this_sleep_cb(const std::function& cb) { on_this_sleep.connect(cb); } - /** Add a callback fired when any actor wakes up from a sleep **/ + /** \static Add a callback fired when any actor wakes up from a sleep **/ static void on_wake_up_cb(const std::function& cb) { on_wake_up.connect(cb); } /** Add a callback fired when this specific actor wakes up from a sleep **/ void on_this_wake_up_cb(const std::function& cb) { on_this_wake_up.connect(cb); } - /** Add a callback fired when any actor is has been migrated to another host **/ + /** \static Add a callback fired when any actor is has been migrated to another host **/ static void on_host_change_cb(const std::function& cb) { on_host_change.connect(cb); @@ -259,7 +261,8 @@ public: on_this_host_change.connect(cb); } - /** Add a callback fired when any actor terminates its code. + /** \static + * Add a callback fired when any actor terminates its code. * @beginrst * The actor may continue to exist if it is still referenced in the simulation, but it's not active anymore. * If you want to free extra data when the actor's destructor is called, use :cpp:func:`Actor::on_destruction_cb`. @@ -274,19 +277,21 @@ public: * @endrst */ void on_this_termination_cb(const std::function& cb) { on_this_termination.connect(cb); } - /** Add a callback fired when an actor is about to disappear (its destructor was called). + /** \static Add a callback fired when an actor is about to disappear (its destructor was called). * This signal is fired for any destructed actor, which is mostly useful when designing plugins and extensions. */ static void on_destruction_cb(const std::function& cb) { on_destruction.connect(cb); } /** Add a callback fired when this specific actor is about to disappear (its destructor was called). */ void on_this_destruction_cb(const std::function& cb) { on_this_destruction.connect(cb); } - /** Create an actor from a @c std::function. + /** \static + * Create an actor from a @c std::function. * If the actor is restarted, it gets a fresh copy of the function. * @verbatim embed:rst:inline See the :ref:`example `. @endverbatim */ static ActorPtr create(const std::string& name, s4u::Host* host, const std::function& code); - /** Create an actor, but don't start it yet. + /** \static + * Create an actor, but don't start it yet. * - * This is useful to set some properties or extension before actually starting it */ + * This is useful to set some properties or extension before actually starting it */ static ActorPtr init(const std::string& name, s4u::Host* host); ActorPtr set_stacksize(unsigned stacksize); /** Start a previously initialized actor */ @@ -307,14 +312,16 @@ public: ActorPtr start(const std::function& code, std::vector args); - /** Create an actor from a callable thing. + /** \static + * Create an actor from a callable thing. * @verbatim embed:rst:inline See the :ref:`example `. @endverbatim */ template static ActorPtr create(const std::string& name, s4u::Host* host, F code) { return create(name, host, std::function(std::move(code))); } - /** Create an actor using a callable thing and its arguments. + /** \static + * Create an actor using a callable thing and its arguments. * * Note that the arguments will be copied, so move-only parameters are forbidden. * @verbatim embed:rst:inline See the :ref:`example `. @endverbatim */ @@ -330,7 +337,8 @@ public: return create(name, host, std::bind(std::move(code), std::move(args)...)); } - /** Create actor from function name and a vector of strings as arguments. + /** \static + * Create actor from function name and a vector of strings as arguments. * @verbatim embed:rst:inline See the :ref:`example `. @endverbatim */ static ActorPtr create(const std::string& name, s4u::Host* host, const std::string& function, std::vector args); @@ -345,6 +353,7 @@ public: /** Returns whether or not this actor has been daemonized or not **/ bool is_daemon() const; + static bool is_maestro(); /** Retrieves the name of that actor as a C++ string */ @@ -418,7 +427,9 @@ public: */ void kill(); - /** Retrieves the actor that have the given PID (or nullptr if not existing) */ + /** \static + * 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. @@ -437,7 +448,9 @@ public: /** Kill that actor and restart it from start. */ Actor* restart(); - /** Kill all actors (but the issuer). Being killed is not something that actors can delay or avoid. */ + /** \static + * 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 */