X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3607c619ddfa018f4ea69a012a3bc722d6b38491..4634214e18b847f6346048fa12179d3d99ae82c9:/include/simgrid/kernel/resource/Action.hpp diff --git a/include/simgrid/kernel/resource/Action.hpp b/include/simgrid/kernel/resource/Action.hpp index d482732388..c8e20eb4bd 100644 --- a/include/simgrid/kernel/resource/Action.hpp +++ b/include/simgrid/kernel/resource/Action.hpp @@ -44,7 +44,11 @@ public: bool empty() const { return heap_type::empty(); } }; -/** @details An action is a consumption on a resource (e.g.: a communication for the network) */ +/** @details An action is a consumption on a resource (e.g.: a communication for the network). + * + * It is related (but still different) from activities, that are the stuff on which an actor can be blocked. + * See simgrid::s4u::Activity for more details. + */ class XBT_PUBLIC Action { friend ActionHeap; @@ -62,12 +66,11 @@ public: StateSet; enum class State { - ready = 0, /**< Ready */ - running, /**< Running */ - failed, /**< Task Failure */ - done, /**< Completed */ - to_free, /**< Action to free in next cleanup */ - not_in_the_system /**< Not in the system anymore. Why did you ask ? */ + inited, /**< Created, but not started yet */ + running, /**< Started, currently running */ + failed, /**< Completed (unsuccessfully: either the resource failed, or the action was canceled) */ + done, /**< Completed (successfully) */ + ignored /**< e.g. failure detectors, these infinite sleep actions that are put on resources which failure should be notified */ }; enum class SuspendStates {