. /include/boost/corosio /detail /op_base.hpp
100.00% Lines (30/30) 100.00% Functions (12/12)
[ ] 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_OP_BASE_HPP 10   #ifndef BOOST_COROSIO_DETAIL_OP_BASE_HPP
11   #define BOOST_COROSIO_DETAIL_OP_BASE_HPP 11   #define BOOST_COROSIO_DETAIL_OP_BASE_HPP
12   12  
13   #include <boost/capy/io_result.hpp> 13   #include <boost/capy/io_result.hpp>
14   #include <boost/capy/ex/executor_ref.hpp> 14   #include <boost/capy/ex/executor_ref.hpp>
15   #include <boost/capy/ex/io_env.hpp> 15   #include <boost/capy/ex/io_env.hpp>
16   16  
17   #include <coroutine> 17   #include <coroutine>
18   #include <cstddef> 18   #include <cstddef>
19   #include <stop_token> 19   #include <stop_token>
20   #include <system_error> 20   #include <system_error>
21   21  
22   namespace boost::corosio::detail { 22   namespace boost::corosio::detail {
23   23  
24   /* CRTP base for awaitables that return io_result<std::size_t>. 24   /* CRTP base for awaitables that return io_result<std::size_t>.
25   25  
26   Derived classes must provide: 26   Derived classes must provide:
27   27  
28   std::coroutine_handle<> dispatch( 28   std::coroutine_handle<> dispatch(
29   std::coroutine_handle<> h, 29   std::coroutine_handle<> h,
30   capy::executor_ref ex) const; 30   capy::executor_ref ex) const;
31   31  
32   which forwards to the backend implementation method, passing 32   which forwards to the backend implementation method, passing
33   token_, &ec_, and &bytes_ as the cancellation/output parameters. 33   token_, &ec_, and &bytes_ as the cancellation/output parameters.
34   */ 34   */
35   template<class Derived> 35   template<class Derived>
36   class bytes_op_base 36   class bytes_op_base
37   { 37   {
38   friend Derived; 38   friend Derived;
HITCBC 39   437646 bytes_op_base() = default; 39   446116 bytes_op_base() = default;
40   40  
41   public: 41   public:
42   std::stop_token token_; 42   std::stop_token token_;
43   mutable std::error_code ec_; 43   mutable std::error_code ec_;
44   mutable std::size_t bytes_ = 0; 44   mutable std::size_t bytes_ = 0;
45   45  
HITCBC 46   437646 bool await_ready() const noexcept 46   446116 bool await_ready() const noexcept
47   { 47   {
48   // A pre-set ec_ means the initiator failed before dispatch 48   // A pre-set ec_ means the initiator failed before dispatch
49   // (e.g. a closed object); complete immediately with that error. 49   // (e.g. a closed object); complete immediately with that error.
HITCBC 50   437646 return static_cast<bool>(ec_) || token_.stop_requested(); 50   446116 return static_cast<bool>(ec_) || token_.stop_requested();
51   } 51   }
52   52  
HITCBC 53   437613 [[nodiscard]] capy::io_result<std::size_t> await_resume() const noexcept 53   446083 [[nodiscard]] capy::io_result<std::size_t> await_resume() const noexcept
54   { 54   {
HITCBC 55   437613 if (token_.stop_requested()) 55   446083 if (token_.stop_requested())
HITCBC 56   243 return {make_error_code(std::errc::operation_canceled), 0}; 56   245 return {make_error_code(std::errc::operation_canceled), 0};
HITCBC 57   437370 return {ec_, bytes_}; 57   445838 return {ec_, bytes_};
58   } 58   }
59   59  
HITCBC 60   437630 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 60   446100 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
61   -> std::coroutine_handle<> 61   -> std::coroutine_handle<>
62   { 62   {
HITCBC 63   437630 token_ = env->stop_token; 63   446100 token_ = env->stop_token;
HITCBC 64   437630 return static_cast<Derived const*>(this)->dispatch(h, env->executor); 64   446100 return static_cast<Derived const*>(this)->dispatch(h, env->executor);
65   } 65   }
66   }; 66   };
67   67  
68   /* CRTP base for awaitables that return io_result<Value> for a 68   /* CRTP base for awaitables that return io_result<Value> for a
69   moved-out result object (e.g. the resolver's result lists). 69   moved-out result object (e.g. the resolver's result lists).
70   70  
71   Derived classes must provide: 71   Derived classes must provide:
72   72  
73   std::coroutine_handle<> dispatch( 73   std::coroutine_handle<> dispatch(
74   std::coroutine_handle<> h, 74   std::coroutine_handle<> h,
75   capy::executor_ref ex) const; 75   capy::executor_ref ex) const;
76   76  
77   which forwards to the backend implementation method, passing 77   which forwards to the backend implementation method, passing
78   token_, &ec_, and &value_ as the cancellation/output parameters. 78   token_, &ec_, and &value_ as the cancellation/output parameters.
79   */ 79   */
80   template<class Derived, class Value> 80   template<class Derived, class Value>
81   class value_op_base 81   class value_op_base
82   { 82   {
83   friend Derived; 83   friend Derived;
HITCBC 84   50 value_op_base() = default; 84   50 value_op_base() = default;
85   85  
86   public: 86   public:
87   std::stop_token token_; 87   std::stop_token token_;
88   mutable std::error_code ec_; 88   mutable std::error_code ec_;
89   mutable Value value_{}; 89   mutable Value value_{};
90   90  
HITCBC 91   50 bool await_ready() const noexcept 91   50 bool await_ready() const noexcept
92   { 92   {
93   // A pre-set ec_ means the initiator failed before dispatch; 93   // A pre-set ec_ means the initiator failed before dispatch;
94   // complete immediately with that error. 94   // complete immediately with that error.
HITCBC 95   50 return static_cast<bool>(ec_) || token_.stop_requested(); 95   50 return static_cast<bool>(ec_) || token_.stop_requested();
96   } 96   }
97   97  
HITCBC 98   48 [[nodiscard]] capy::io_result<Value> await_resume() const noexcept 98   48 [[nodiscard]] capy::io_result<Value> await_resume() const noexcept
99   { 99   {
HITCBC 100   48 if (token_.stop_requested()) 100   48 if (token_.stop_requested())
HITCBC 101   2 return {make_error_code(std::errc::operation_canceled), {}}; 101   2 return {make_error_code(std::errc::operation_canceled), {}};
HITCBC 102   46 return {ec_, std::move(value_)}; 102   46 return {ec_, std::move(value_)};
103   } 103   }
104   104  
HITCBC 105   50 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 105   50 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
106   -> std::coroutine_handle<> 106   -> std::coroutine_handle<>
107   { 107   {
HITCBC 108   50 token_ = env->stop_token; 108   50 token_ = env->stop_token;
HITCBC 109   50 return static_cast<Derived const*>(this)->dispatch(h, env->executor); 109   50 return static_cast<Derived const*>(this)->dispatch(h, env->executor);
110   } 110   }
111   }; 111   };
112   112  
113   /* CRTP base for awaitables that return io_result<>. 113   /* CRTP base for awaitables that return io_result<>.
114   114  
115   Derived classes must provide: 115   Derived classes must provide:
116   116  
117   std::coroutine_handle<> dispatch( 117   std::coroutine_handle<> dispatch(
118   std::coroutine_handle<> h, 118   std::coroutine_handle<> h,
119   capy::executor_ref ex) const; 119   capy::executor_ref ex) const;
120   120  
121   which forwards to the backend implementation method, passing 121   which forwards to the backend implementation method, passing
122   token_ and &ec_ as the cancellation/output parameters. 122   token_ and &ec_ as the cancellation/output parameters.
123   */ 123   */
124   template<class Derived> 124   template<class Derived>
125   class void_op_base 125   class void_op_base
126   { 126   {
127   friend Derived; 127   friend Derived;
HITCBC 128   4650 void_op_base() = default; 128   4675 void_op_base() = default;
129   129  
130   public: 130   public:
131   std::stop_token token_; 131   std::stop_token token_;
132   mutable std::error_code ec_; 132   mutable std::error_code ec_;
133   133  
HITCBC 134   4650 bool await_ready() const noexcept 134   4675 bool await_ready() const noexcept
135   { 135   {
136   // A pre-set ec_ means the initiator failed before dispatch 136   // A pre-set ec_ means the initiator failed before dispatch
137   // (e.g. auto-open); complete immediately with that error. 137   // (e.g. auto-open); complete immediately with that error.
HITCBC 138   4650 return static_cast<bool>(ec_) || token_.stop_requested(); 138   4675 return static_cast<bool>(ec_) || token_.stop_requested();
139   } 139   }
140   140  
HITCBC 141   4637 [[nodiscard]] capy::io_result<> await_resume() const noexcept 141   4662 [[nodiscard]] capy::io_result<> await_resume() const noexcept
142   { 142   {
HITCBC 143   4637 if (token_.stop_requested()) 143   4662 if (token_.stop_requested())
HITCBC 144   32 return {make_error_code(std::errc::operation_canceled)}; 144   32 return {make_error_code(std::errc::operation_canceled)};
HITCBC 145   4605 return {ec_}; 145   4630 return {ec_};
146   } 146   }
147   147  
HITCBC 148   4646 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 148   4671 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
149   -> std::coroutine_handle<> 149   -> std::coroutine_handle<>
150   { 150   {
HITCBC 151   4646 token_ = env->stop_token; 151   4671 token_ = env->stop_token;
HITCBC 152   4646 return static_cast<Derived const*>(this)->dispatch(h, env->executor); 152   4671 return static_cast<Derived const*>(this)->dispatch(h, env->executor);
153   } 153   }
154   }; 154   };
155   155  
156   } // namespace boost::corosio::detail 156   } // namespace boost::corosio::detail
157   157  
158   #endif // BOOST_COROSIO_DETAIL_OP_BASE_HPP 158   #endif // BOOST_COROSIO_DETAIL_OP_BASE_HPP