#ifndef SIMGRID_S4U_ACTIVITY_HPP
#define SIMGRID_S4U_ACTIVITY_HPP
-#include <simgrid/s4u/forward.hpp>
#include <simgrid/forward.h>
-enum e_s4u_activity_state_t { inited = 0, started, canceled, errored, finished };
-
namespace simgrid {
namespace s4u {
/** @brief Activities
*
- * This class is the ancestor of every activities that an actor can undertake, that is, of the actions that do take time in the simulated world.
+ * This class is the ancestor of every activities that an actor can undertake.
+ * That is, activities are all the things that do take time to the actor in the simulated world.
+ *
+ * They are somewhat linked but not identical to simgrid::kernel::resource::Action,
+ * that are stuff occurring on a resource:
+ *
+ * - A sequential execution activity encompasses 2 actions: one for the exec itself,
+ * and a time-limited sleep used as timeout detector.
+ * - A point-to-point communication activity encompasses 3 actions: one for the comm itself
+ * (which spans on all links of the path), and one infinite sleep used as failure detector
+ * on both sender and receiver hosts.
+ * - Synchronization activities may possibly be connected to no action.
*/
class XBT_PUBLIC Activity {
friend Comm;
Activity(Activity const&) = delete;
Activity& operator=(Activity const&) = delete;
+ enum class State { INITED = 0, STARTED, CANCELED, ERRORED, FINISHED };
+
/** Starts a previously created activity.
*
* This function is optional: you can call wait() even if you didn't call start()
/** Cancel that activity */
//virtual void cancel();
/** Retrieve the current state of the activity */
- e_s4u_activity_state_t getState() {return state_;}
+ Activity::State get_state() { return state_; }
/** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
- virtual double getRemains();
+ virtual double get_remaining();
+
/** Set the [remaining] amount of work that this Activity will entail
*
* It is forbidden to change the amount of work once the Activity is started */
- Activity* setRemains(double remains);
+ Activity* set_remaining(double remains);
/** Put some user data onto the Activity */
- Activity* setUserData(void* data)
+ Activity* set_user_data(void* data)
{
user_data_ = data;
return this;
}
/** Retrieve the user data of the Activity */
- void* getUserData() { return user_data_; }
+ void* get_user_data() { return user_data_; }
+
+ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_state()") Activity::State getState() { return state_; }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_remaining()") double getRemains() { return get_remaining(); }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_remaining()") Activity* setRemains(double remains)
+ {
+ return set_remaining(remains);
+ }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_user_data()") Activity* setUserData(void* data)
+ {
+ return set_user_data(data);
+ }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_user_data()") void* getUserData() { return user_data_; }
private:
simgrid::kernel::activity::ActivityImplPtr pimpl_ = nullptr;
- e_s4u_activity_state_t state_ = inited;
+ Activity::State state_ = Activity::State::INITED;
double remains_ = 0;
void* user_data_ = nullptr;
}; // class