X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6a8d5cf4199454b5f811043c207d195107743e72..0a627c31b59202d8f087c64ec40cc14fc0d3a5c4:/include/simgrid/s4u/Activity.hpp diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp index 7e53d03c78..0ae0cbb3ff 100644 --- a/include/simgrid/s4u/Activity.hpp +++ b/include/simgrid/s4u/Activity.hpp @@ -1,4 +1,4 @@ -/* 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. */ @@ -7,6 +7,7 @@ #define SIMGRID_S4U_ACTIVITY_HPP #include +#include namespace simgrid { namespace s4u { @@ -27,20 +28,25 @@ namespace s4u { * - Synchronization activities may possibly be connected to no action. */ class XBT_PUBLIC Activity { - friend Comm; + friend simgrid::s4u::Comm; friend XBT_PUBLIC void intrusive_ptr_release(Comm * c); friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm * c); - friend Exec; + friend simgrid::s4u::Exec; friend XBT_PUBLIC void intrusive_ptr_release(Exec * e); friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec * e); + friend simgrid::s4u::Io; + friend XBT_PUBLIC void intrusive_ptr_release(Io* i); + friend XBT_PUBLIC void intrusive_ptr_add_ref(Io* i); protected: Activity() = default; 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 }; @@ -49,17 +55,21 @@ public: * 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(); @@ -78,30 +88,31 @@ public: /** Retrieve the user data of the Activity */ void* get_user_data() { return user_data_; } - /** @deprecated See Activity::get_state()*/ + kernel::activity::ActivityImplPtr get_impl() { return pimpl_; } + +#ifndef DOXYGEN + XBT_ATTRIB_DEPRECATED_v324("Please use Activity::wait_for()") virtual void wait(double timeout) = 0; 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_; } +#endif private: - simgrid::kernel::activity::ActivityImplPtr pimpl_ = nullptr; - Activity::State state_ = Activity::State::INITED; - double remains_ = 0; - void* user_data_ = nullptr; -}; // class - -}}; // Namespace simgrid::s4u + 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 */