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