. /include/boost/corosio /detail /op_base.hpp
100.00% Lines (22/22) 100.00% Functions (8/8)
[ ] 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   421126 bytes_op_base() = default; 39   675383 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   421126 bool await_ready() const noexcept 46   675383 bool await_ready() const noexcept
47   { 47   {
ECB 48 - 421126 return token_.stop_requested(); 48 + // A pre-set ec_ means the initiator failed before dispatch
  49 + // (e.g. a closed object); complete immediately with that error.
HITGNC   50 + 675383 return static_cast<bool>(ec_) || token_.stop_requested();
49   } 51   }
50   52  
HITCBC 51   421114 [[nodiscard]] capy::io_result<std::size_t> await_resume() const noexcept 53   675371 [[nodiscard]] capy::io_result<std::size_t> await_resume() const noexcept
52   { 54   {
HITCBC 53   421114 if (token_.stop_requested()) 55   675371 if (token_.stop_requested())
HITCBC 54   241 return {make_error_code(std::errc::operation_canceled), 0}; 56   250 return {make_error_code(std::errc::operation_canceled), 0};
HITCBC 55   420873 return {ec_, bytes_}; 57   675121 return {ec_, bytes_};
56   } 58   }
57   59  
HITCBC 58   421126 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 60   675367 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
59   -> std::coroutine_handle<> 61   -> std::coroutine_handle<>
60   { 62   {
HITCBC 61   421126 token_ = env->stop_token; 63   675367 token_ = env->stop_token;
HITCBC 62   421126 return static_cast<Derived const*>(this)->dispatch( 64   675367 return static_cast<Derived const*>(this)->dispatch(
HITCBC 63   421126 h, env->executor); 65   675367 h, env->executor);
64   } 66   }
65   }; 67   };
66   68  
67   /* CRTP base for awaitables that return io_result<>. 69   /* CRTP base for awaitables that return io_result<>.
68   70  
69   Derived classes must provide: 71   Derived classes must provide:
70   72  
71   std::coroutine_handle<> dispatch( 73   std::coroutine_handle<> dispatch(
72   std::coroutine_handle<> h, 74   std::coroutine_handle<> h,
73   capy::executor_ref ex) const; 75   capy::executor_ref ex) const;
74   76  
75   which forwards to the backend implementation method, passing 77   which forwards to the backend implementation method, passing
76   token_ and &ec_ as the cancellation/output parameters. 78   token_ and &ec_ as the cancellation/output parameters.
77   */ 79   */
78   template<class Derived> 80   template<class Derived>
79   class void_op_base 81   class void_op_base
80   { 82   {
81   friend Derived; 83   friend Derived;
HITCBC 82   5870 void_op_base() = default; 84   7165 void_op_base() = default;
83   85  
84   public: 86   public:
85   std::stop_token token_; 87   std::stop_token token_;
86   mutable std::error_code ec_; 88   mutable std::error_code ec_;
87   89  
HITCBC 88   5870 bool await_ready() const noexcept 90   7165 bool await_ready() const noexcept
89   { 91   {
ECB 90 - 5870 return token_.stop_requested(); 92 + // A pre-set ec_ means the initiator failed before dispatch
  93 + // (e.g. auto-open); complete immediately with that error.
HITGNC   94 + 7165 return static_cast<bool>(ec_) || token_.stop_requested();
91   } 95   }
92   96  
HITCBC 93   5870 [[nodiscard]] capy::io_result<> await_resume() const noexcept 97   7165 [[nodiscard]] capy::io_result<> await_resume() const noexcept
94   { 98   {
HITCBC 95   5870 if (token_.stop_requested()) 99   7165 if (token_.stop_requested())
HITCBC 96   32 return {make_error_code(std::errc::operation_canceled)}; 100   32 return {make_error_code(std::errc::operation_canceled)};
HITCBC 97   5838 return {ec_}; 101   7133 return {ec_};
98   } 102   }
99   103  
HITCBC 100   5870 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 104   7161 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
101   -> std::coroutine_handle<> 105   -> std::coroutine_handle<>
102   { 106   {
HITCBC 103   5870 token_ = env->stop_token; 107   7161 token_ = env->stop_token;
HITCBC 104   5870 return static_cast<Derived const*>(this)->dispatch( 108   7161 return static_cast<Derived const*>(this)->dispatch(
HITCBC 105   5870 h, env->executor); 109   7161 h, env->executor);
106   } 110   }
107   }; 111   };
108   112  
109   } // namespace boost::corosio::detail 113   } // namespace boost::corosio::detail
110   114  
111   #endif // BOOST_COROSIO_DETAIL_OP_BASE_HPP 115   #endif // BOOST_COROSIO_DETAIL_OP_BASE_HPP