. /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   4520 explicit conditionally_enabled_event(bool enabled = true) noexcept 34   4520 explicit conditionally_enabled_event(bool enabled = true) noexcept
HITCBC 35   4520 : enabled_(enabled) 35   4520 : enabled_(enabled)
36   { 36   {
HITCBC 37   4520 } 37   4520 }
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&
41   operator=(conditionally_enabled_event const&) = delete; 41   operator=(conditionally_enabled_event const&) = delete;
42   42  
HITCBC 43   4504 void set_enabled(bool v) noexcept 43   4504 void set_enabled(bool v) noexcept
44   { 44   {
HITCBC 45   4504 enabled_ = v; 45   4504 enabled_ = v;
HITCBC 46   4504 } 46   4504 }
47   47  
HITCBC 48   4513 void notify_one() 48   4402 void notify_one()
49   { 49   {
HITCBC 50   4513 if (enabled_) 50   4402 if (enabled_)
HITCBC 51   4513 cond_.notify_one(); 51   4402 cond_.notify_one();
HITCBC 52   4513 } 52   4402 }
53   53  
HITCBC 54   11833 void notify_all() 54   11786 void notify_all()
55   { 55   {
HITCBC 56   11833 if (enabled_) 56   11786 if (enabled_)
HITCBC 57   11817 cond_.notify_all(); 57   11770 cond_.notify_all();
HITCBC 58   11833 } 58   11786 }
59   59  
HITCBC 60   901 void wait(conditionally_enabled_mutex::scoped_lock& lock) 60   783 void wait(conditionally_enabled_mutex::scoped_lock& lock)
61   { 61   {
HITCBC 62   901 if (enabled_) 62   783 if (enabled_)
HITCBC 63   901 cond_.wait(lock.underlying()); 63   783 cond_.wait(lock.underlying());
HITCBC 64   901 } 64   783 }
65   65  
66   template<class Rep, class Period> 66   template<class Rep, class Period>
HITCBC 67   10 void wait_for( 67   16 void wait_for(
68   conditionally_enabled_mutex::scoped_lock& lock, 68   conditionally_enabled_mutex::scoped_lock& lock,
69   std::chrono::duration<Rep, Period> const& d) 69   std::chrono::duration<Rep, Period> const& d)
70   { 70   {
HITCBC 71   10 if (enabled_) 71   16 if (enabled_)
HITCBC 72   10 cond_.wait_for(lock.underlying(), d); 72   16 cond_.wait_for(lock.underlying(), d);
HITCBC 73   10 } 73   16 }
74   }; 74   };
75   75  
76   } // namespace boost::corosio::detail 76   } // namespace boost::corosio::detail
77   77  
78   #endif // BOOST_COROSIO_DETAIL_CONDITIONALLY_ENABLED_EVENT_HPP 78   #endif // BOOST_COROSIO_DETAIL_CONDITIONALLY_ENABLED_EVENT_HPP