1 /* Copyright (c) 2006-2023. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_S4U_ACTIVITYSET_HPP
7 #define SIMGRID_S4U_ACTIVITYSET_HPP
9 #include <simgrid/forward.h>
10 #include <simgrid/s4u/Activity.hpp>
14 namespace simgrid::s4u {
15 /** @brief ActivitiesSet
17 * This class is a container of activities, allowing to wait for the completion of any or all activities in the set.
18 * This is somehow similar to the select(2) system call under UNIX, allowing you to wait for the next event about these
21 class XBT_PUBLIC ActivitySet : public xbt::Extendable<ActivitySet> {
22 std::vector<ActivityPtr>
23 activities_; // We use a vector instead of a set to improve reproductibility accross architectures
24 std::vector<ActivityPtr> failed_activities_;
27 ActivitySet() = default;
28 ActivitySet(const std::vector<ActivityPtr> init) : activities_(init) {}
29 ~ActivitySet() = default;
31 /** Add an activity to the set */
32 void push(ActivityPtr a) { activities_.push_back(a); }
33 /** Remove that activity from the set (no-op if the activity is not in the set) */
34 void erase(ActivityPtr a);
36 /** Get the amount of activities in the set. Failed activities (if any) are not counted */
37 int size() { return activities_.size(); }
38 /** Return whether the set is empty. Failed activities (if any) are not counted */
39 int empty() { return activities_.empty(); }
41 /** Wait for the completion of all activities in the set, but not longer than the provided timeout
43 * On timeout, an exception is raised, and the completed activities remain in the set. Use test_any() to retrieve
46 * When no timeout occures, the set is emptied.
48 void wait_all_for(double timeout);
49 /** Wait for the completion of all activities in the set. The set is emptied afterward. */
50 void wait_all() { wait_all_for(-1); }
51 /** Returns the first terminated activity if any, or ActivityPtr(nullptr) if no activity is terminated */
52 ActivityPtr test_any();
54 /** Wait for the completion of one activity from the set, but not longer than the provided timeout.
56 * See wait_any() for details.
58 * @return the first terminated activity, which is automatically removed from the set.
61 ActivityPtr wait_any_for(double timeout);
62 /** Wait for the completion of one activity from the set.
64 * If an activity fails during that time, an exception is raised, and the failed exception is marked as failed in the
65 * set. Use get_failed_activity() to retrieve it.
67 * If more than one activity failed, the other ones are also removed from the set. Use get_failed_activity() several
68 * time to retrieve them all.
70 * @return the first terminated activity, which is automatically removed from the set. If more than one activity
71 * terminated at the same timestamp, then the other ones are still in the set. Use either test_any() or wait_any() to
72 * retrieve the other ones.
74 ActivityPtr wait_any() { return wait_any_for(-1); }
76 ActivityPtr get_failed_activity();
77 bool has_failed_activities() { return not failed_activities_.empty(); }
80 }; // namespace simgrid::s4u