-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2019. 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. */
* - Synchronization activities may possibly be connected to no action.
*/
class XBT_PUBLIC Activity {
- friend simgrid::s4u::Comm;
+ friend Comm;
friend XBT_PUBLIC void intrusive_ptr_release(Comm * c);
friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm * c);
- friend simgrid::s4u::Exec;
+
+ friend Exec;
+ friend ExecSeq;
+ friend ExecPar;
friend XBT_PUBLIC void intrusive_ptr_release(Exec * e);
friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec * e);
- friend simgrid::s4u::Io;
+
+ friend Io;
friend XBT_PUBLIC void intrusive_ptr_release(Io* i);
friend XBT_PUBLIC void intrusive_ptr_add_ref(Io* i);
virtual ~Activity() = default;
public:
+#ifndef DOXYGEN
Activity(Activity const&) = delete;
Activity& operator=(Activity const&) = delete;
+#endif
enum class State { INITED = 0, STARTED, CANCELED, ERRORED, FINISHED };
* This function is optional: you can call wait() even if you didn't call start()
*/
virtual Activity* start() = 0;
- /** Tests whether the given activity is terminated yet. This is a pure function. */
- //virtual bool test()=0;
/** Blocks until the activity is terminated */
virtual Activity* wait() = 0;
/** Blocks until the activity is terminated, or until the timeout is elapsed
* Raises: timeout exception.*/
- virtual Activity* wait(double timeout) = 0;
+ virtual Activity* wait_for(double timeout) = 0;
+ /** Blocks until the activity is terminated, or until the time limit is reached
+ * Raises: timeout exception. */
+ void wait_until(double time_limit);
+
/** Cancel that activity */
virtual Activity* cancel() = 0;
/** Retrieve the current state of the activity */
Activity::State get_state() { return state_; }
+ /** Tests whether the given activity is terminated yet. This is a pure function. */
+ virtual bool test() = 0;
/** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
virtual double get_remaining();
/** Retrieve the user data of the Activity */
void* get_user_data() { return user_data_; }
- /** @deprecated See Activity::get_state()*/
- XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_state()") Activity::State getState() { return state_; }
- /** @deprecated See Activity::get_remaining() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_remaining()") double getRemains() { return get_remaining(); }
- /** @deprecated See Activity::set_remaining() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_remaining()") Activity* setRemains(double remains)
- {
- return set_remaining(remains);
- }
- /** @deprecated See Activity::set_user_data() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_user_data()") Activity* setUserData(void* data)
- {
- return set_user_data(data);
- }
- /** @deprecated See Activity::get_user_data() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_user_data()") void* getUserData() { return user_data_; }
+ kernel::activity::ActivityImplPtr get_impl() { return pimpl_; }
-private:
- simgrid::kernel::activity::ActivityImplPtr pimpl_ = nullptr;
- Activity::State state_ = Activity::State::INITED;
- double remains_ = 0;
- void* user_data_ = nullptr;
-}; // class
+#ifndef DOXYGEN
+ XBT_ATTRIB_DEPRECATED_v324("Please use Activity::wait_for()") virtual void wait(double timeout) = 0;
+#endif
-}}; // Namespace simgrid::s4u
+private:
+ kernel::activity::ActivityImplPtr pimpl_ = nullptr;
+ Activity::State state_ = Activity::State::INITED;
+ double remains_ = 0;
+ void* user_data_ = nullptr;
+};
+
+} // namespace s4u
+} // namespace simgrid
#endif /* SIMGRID_S4U_ACTIVITY_HPP */