include/boost/corosio/detail/conditionally_enabled_event.hpp

100.0% Lines (22 / 22) 100.0% Functions (6 / 6)
conditionally_enabled_event.hpp
f(x) Functions (6)
Line TLA Hits Source Code
1 //
2 // Copyright (c) 2026 Michael Vandeberg
3 //
4 // Distributed under the Boost Software License, Version 1.0. (See accompanying
5 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6 //
7 // Official repository: https://github.com/cppalliance/corosio
8 //
9
10 #ifndef BOOST_COROSIO_DETAIL_CONDITIONALLY_ENABLED_EVENT_HPP
11 #define BOOST_COROSIO_DETAIL_CONDITIONALLY_ENABLED_EVENT_HPP
12
13 #include <boost/corosio/detail/conditionally_enabled_mutex.hpp>
14
15 #include <chrono>
16 #include <condition_variable>
17
18 namespace boost::corosio::detail {
19
20 /* Condition variable wrapper that becomes a no-op when disabled.
21
22 When enabled, notify/wait delegate to an underlying
23 std::condition_variable. When disabled, all operations
24 are no-ops. The wait paths are unreachable in
25 single-threaded mode because the task sentinel prevents
26 the empty-queue state in do_one().
27 */
28 class conditionally_enabled_event
29 {
30 std::condition_variable cond_;
31 bool enabled_;
32
33 public:
34 2253x explicit conditionally_enabled_event(bool enabled = true) noexcept
35 2253x : enabled_(enabled)
36 {
37 2253x }
38
39 conditionally_enabled_event(conditionally_enabled_event const&) = delete;
40 conditionally_enabled_event&
41 operator=(conditionally_enabled_event const&) = delete;
42
43 2241x void set_enabled(bool v) noexcept
44 {
45 2241x enabled_ = v;
46 2241x }
47
48 39x void notify_one()
49 {
50 39x if (enabled_)
51 39x cond_.notify_one();
52 39x }
53
54 5100x void notify_all()
55 {
56 5100x if (enabled_)
57 5088x cond_.notify_all();
58 5100x }
59
60 8x void wait(conditionally_enabled_mutex::scoped_lock& lock)
61 {
62 8x if (enabled_)
63 8x cond_.wait(lock.underlying());
64 8x }
65
66 template<class Rep, class Period>
67 13x void wait_for(
68 conditionally_enabled_mutex::scoped_lock& lock,
69 std::chrono::duration<Rep, Period> const& d)
70 {
71 13x if (enabled_)
72 13x cond_.wait_for(lock.underlying(), d);
73 13x }
74 };
75
76 } // namespace boost::corosio::detail
77
78 #endif // BOOST_COROSIO_DETAIL_CONDITIONALLY_ENABLED_EVENT_HPP
79