TLA  Line data    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_OP_BASE_HPP
      11                 : #define BOOST_COROSIO_DETAIL_OP_BASE_HPP
      12                 : 
      13                 : #include <boost/capy/io_result.hpp>
      14                 : #include <boost/capy/ex/executor_ref.hpp>
      15                 : #include <boost/capy/ex/io_env.hpp>
      16                 : 
      17                 : #include <coroutine>
      18                 : #include <cstddef>
      19                 : #include <stop_token>
      20                 : #include <system_error>
      21                 : 
      22                 : namespace boost::corosio::detail {
      23                 : 
      24                 : /* CRTP base for awaitables that return io_result<std::size_t>.
      25                 : 
      26                 :    Derived classes must provide:
      27                 : 
      28                 :      std::coroutine_handle<> dispatch(
      29                 :          std::coroutine_handle<> h,
      30                 :          capy::executor_ref ex) const;
      31                 : 
      32                 :    which forwards to the backend implementation method, passing
      33                 :    token_, &ec_, and &bytes_ as the cancellation/output parameters.
      34                 : */
      35                 : template<class Derived>
      36                 : class bytes_op_base
      37                 : {
      38                 :     friend Derived;
      39 HIT      406215 :     bytes_op_base() = default;
      40                 : 
      41                 : public:
      42                 :     std::stop_token token_;
      43                 :     mutable std::error_code ec_;
      44                 :     mutable std::size_t bytes_ = 0;
      45                 : 
      46          406215 :     bool await_ready() const noexcept
      47                 :     {
      48          406215 :         return token_.stop_requested();
      49                 :     }
      50                 : 
      51          406215 :     capy::io_result<std::size_t> await_resume() const noexcept
      52                 :     {
      53          406215 :         if (token_.stop_requested())
      54             195 :             return {make_error_code(std::errc::operation_canceled), 0};
      55          406020 :         return {ec_, bytes_};
      56                 :     }
      57                 : 
      58          406215 :     auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
      59                 :         -> std::coroutine_handle<>
      60                 :     {
      61          406215 :         token_ = env->stop_token;
      62          406215 :         return static_cast<Derived const*>(this)->dispatch(
      63          406215 :             h, env->executor);
      64                 :     }
      65                 : };
      66                 : 
      67                 : /* CRTP base for awaitables that return io_result<>.
      68                 : 
      69                 :    Derived classes must provide:
      70                 : 
      71                 :      std::coroutine_handle<> dispatch(
      72                 :          std::coroutine_handle<> h,
      73                 :          capy::executor_ref ex) const;
      74                 : 
      75                 :    which forwards to the backend implementation method, passing
      76                 :    token_ and &ec_ as the cancellation/output parameters.
      77                 : */
      78                 : template<class Derived>
      79                 : class void_op_base
      80                 : {
      81                 :     friend Derived;
      82            8530 :     void_op_base() = default;
      83                 : 
      84                 : public:
      85                 :     std::stop_token token_;
      86                 :     mutable std::error_code ec_;
      87                 : 
      88            8530 :     bool await_ready() const noexcept
      89                 :     {
      90            8530 :         return token_.stop_requested();
      91                 :     }
      92                 : 
      93            8530 :     capy::io_result<> await_resume() const noexcept
      94                 :     {
      95            8530 :         if (token_.stop_requested())
      96 MIS           0 :             return {make_error_code(std::errc::operation_canceled)};
      97 HIT        8530 :         return {ec_};
      98                 :     }
      99                 : 
     100            8530 :     auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
     101                 :         -> std::coroutine_handle<>
     102                 :     {
     103            8530 :         token_ = env->stop_token;
     104            8530 :         return static_cast<Derived const*>(this)->dispatch(
     105            8530 :             h, env->executor);
     106                 :     }
     107                 : };
     108                 : 
     109                 : } // namespace boost::corosio::detail
     110                 : 
     111                 : #endif // BOOST_COROSIO_DETAIL_OP_BASE_HPP