. /include/boost/corosio /native /native_tcp_acceptor.hpp
92.86% Lines (39/42) 100.00% Functions (13/13)
[ ] prev/next file n p prev/next uncovered line
TLA Baseline Branch
Line Hits Code Line Hits Code
1   // 1   //
2   // Copyright (c) 2026 Steve Gerbino 2   // Copyright (c) 2026 Steve Gerbino
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_NATIVE_NATIVE_TCP_ACCEPTOR_HPP 10   #ifndef BOOST_COROSIO_NATIVE_NATIVE_TCP_ACCEPTOR_HPP
11   #define BOOST_COROSIO_NATIVE_NATIVE_TCP_ACCEPTOR_HPP 11   #define BOOST_COROSIO_NATIVE_NATIVE_TCP_ACCEPTOR_HPP
12   12  
13   #include <boost/corosio/tcp_acceptor.hpp> 13   #include <boost/corosio/tcp_acceptor.hpp>
14   #include <boost/corosio/backend.hpp> 14   #include <boost/corosio/backend.hpp>
15   15  
16   #ifndef BOOST_COROSIO_MRDOCS 16   #ifndef BOOST_COROSIO_MRDOCS
17   #if BOOST_COROSIO_HAS_EPOLL 17   #if BOOST_COROSIO_HAS_EPOLL
18   #include <boost/corosio/native/detail/epoll/epoll_types.hpp> 18   #include <boost/corosio/native/detail/epoll/epoll_types.hpp>
19   #endif 19   #endif
20   20  
21   #if BOOST_COROSIO_HAS_SELECT 21   #if BOOST_COROSIO_HAS_SELECT
22   #include <boost/corosio/native/detail/select/select_types.hpp> 22   #include <boost/corosio/native/detail/select/select_types.hpp>
23   #endif 23   #endif
24   24  
25   #if BOOST_COROSIO_HAS_KQUEUE 25   #if BOOST_COROSIO_HAS_KQUEUE
26   #include <boost/corosio/native/detail/kqueue/kqueue_types.hpp> 26   #include <boost/corosio/native/detail/kqueue/kqueue_types.hpp>
27   #endif 27   #endif
28   28  
29   #if BOOST_COROSIO_HAS_IOCP 29   #if BOOST_COROSIO_HAS_IOCP
30   #include <boost/corosio/native/detail/iocp/win_tcp_acceptor_service.hpp> 30   #include <boost/corosio/native/detail/iocp/win_tcp_acceptor_service.hpp>
31   #endif 31   #endif
32   #endif // !BOOST_COROSIO_MRDOCS 32   #endif // !BOOST_COROSIO_MRDOCS
33   33  
34   namespace boost::corosio { 34   namespace boost::corosio {
35   35  
36   /** An asynchronous TCP acceptor with devirtualized accept operations. 36   /** An asynchronous TCP acceptor with devirtualized accept operations.
37   37  
38   This class template inherits from @ref tcp_acceptor and shadows 38   This class template inherits from @ref tcp_acceptor and shadows
39   the `accept` operation with a version that calls the backend 39   the `accept` operation with a version that calls the backend
40   implementation directly, allowing the compiler to inline through 40   implementation directly, allowing the compiler to inline through
41   the entire call chain. 41   the entire call chain.
42   42  
43   Non-async operations (`listen`, `close`, `cancel`) remain 43   Non-async operations (`listen`, `close`, `cancel`) remain
44   unchanged and dispatch through the compiled library. 44   unchanged and dispatch through the compiled library.
45   45  
46   A `native_tcp_acceptor` IS-A `tcp_acceptor` and can be passed 46   A `native_tcp_acceptor` IS-A `tcp_acceptor` and can be passed
47   to any function expecting `tcp_acceptor&`. 47   to any function expecting `tcp_acceptor&`.
48   48  
49   @tparam Backend A backend tag value (e.g., `epoll`). 49   @tparam Backend A backend tag value (e.g., `epoll`).
50   50  
51   @par Thread Safety 51   @par Thread Safety
52   Same as @ref tcp_acceptor. 52   Same as @ref tcp_acceptor.
53   53  
54   @see tcp_acceptor, epoll_t, iocp_t 54   @see tcp_acceptor, epoll_t, iocp_t
55   */ 55   */
56   template<auto Backend> 56   template<auto Backend>
57   class native_tcp_acceptor : public tcp_acceptor 57   class native_tcp_acceptor : public tcp_acceptor
58   { 58   {
59   using backend_type = decltype(Backend); 59   using backend_type = decltype(Backend);
60   using impl_type = typename backend_type::tcp_acceptor_type; 60   using impl_type = typename backend_type::tcp_acceptor_type;
61   using service_type = typename backend_type::tcp_acceptor_service_type; 61   using service_type = typename backend_type::tcp_acceptor_service_type;
62   62  
HITCBC 63   10 impl_type& get_impl() noexcept 63   10 impl_type& get_impl() noexcept
64   { 64   {
HITCBC 65   10 return *static_cast<impl_type*>(h_.get()); 65   10 return *static_cast<impl_type*>(h_.get());
66   } 66   }
67   67  
68   struct native_wait_awaitable 68   struct native_wait_awaitable
69   { 69   {
70   native_tcp_acceptor& acc_; 70   native_tcp_acceptor& acc_;
71   wait_type w_; 71   wait_type w_;
72   std::stop_token token_; 72   std::stop_token token_;
73   mutable std::error_code ec_; 73   mutable std::error_code ec_;
74   74  
HITCBC 75   2 native_wait_awaitable(native_tcp_acceptor& acc, wait_type w) noexcept 75   2 native_wait_awaitable(native_tcp_acceptor& acc, wait_type w) noexcept
HITCBC 76   2 : acc_(acc) 76   2 : acc_(acc)
HITCBC 77   2 , w_(w) 77   2 , w_(w)
78   { 78   {
HITCBC 79   2 } 79   2 }
80   80  
HITCBC 81   2 bool await_ready() const noexcept 81   2 bool await_ready() const noexcept
82   { 82   {
HITCBC 83   2 return token_.stop_requested(); 83   2 return token_.stop_requested();
84   } 84   }
85   85  
HITCBC 86   2 capy::io_result<> await_resume() const noexcept 86   2 capy::io_result<> await_resume() const noexcept
87   { 87   {
HITCBC 88   2 if (token_.stop_requested()) 88   2 if (token_.stop_requested())
MISUBC 89   ✗ return {make_error_code(std::errc::operation_canceled)}; 89   ✗ return {make_error_code(std::errc::operation_canceled)};
HITCBC 90   2 return {ec_}; 90   2 return {ec_};
91   } 91   }
92   92  
HITCBC 93   2 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 93   2 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
94   -> std::coroutine_handle<> 94   -> std::coroutine_handle<>
95   { 95   {
HITCBC 96   2 token_ = env->stop_token; 96   2 token_ = env->stop_token;
HITCBC 97   6 return acc_.get_impl().wait( 97   6 return acc_.get_impl().wait(
HITCBC 98   6 h, env->executor, w_, token_, &ec_); 98   6 h, env->executor, w_, token_, &ec_);
99   } 99   }
100   }; 100   };
101   101  
102   struct native_accept_awaitable 102   struct native_accept_awaitable
103   { 103   {
104   native_tcp_acceptor& acc_; 104   native_tcp_acceptor& acc_;
105   tcp_socket& peer_; 105   tcp_socket& peer_;
106   std::stop_token token_; 106   std::stop_token token_;
107   mutable std::error_code ec_; 107   mutable std::error_code ec_;
108   mutable io_object::implementation* peer_impl_ = nullptr; 108   mutable io_object::implementation* peer_impl_ = nullptr;
109   109  
HITCBC 110   8 native_accept_awaitable( 110   8 native_accept_awaitable(
111   native_tcp_acceptor& acc, tcp_socket& peer) noexcept 111   native_tcp_acceptor& acc, tcp_socket& peer) noexcept
HITCBC 112   8 : acc_(acc) 112   8 : acc_(acc)
HITCBC 113   8 , peer_(peer) 113   8 , peer_(peer)
114   { 114   {
HITCBC 115   8 } 115   8 }
116   116  
HITCBC 117   8 bool await_ready() const noexcept 117   8 bool await_ready() const noexcept
118   { 118   {
HITCBC 119   8 return token_.stop_requested(); 119   8 return token_.stop_requested();
120   } 120   }
121   121  
HITCBC 122   8 capy::io_result<> await_resume() const noexcept 122   8 capy::io_result<> await_resume() const noexcept
123   { 123   {
HITCBC 124   8 if (token_.stop_requested()) 124   8 if (token_.stop_requested())
MISUBC 125   ✗ return {make_error_code(std::errc::operation_canceled)}; 125   ✗ return {make_error_code(std::errc::operation_canceled)};
HITCBC 126   8 if (!ec_) 126   8 if (!ec_)
HITCBC 127   8 acc_.reset_peer_impl(peer_, peer_impl_); 127   8 acc_.reset_peer_impl(peer_, peer_impl_);
HITCBC 128   8 return {ec_}; 128   8 return {ec_};
129   } 129   }
130   130  
HITCBC 131   8 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 131   8 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
132   -> std::coroutine_handle<> 132   -> std::coroutine_handle<>
133   { 133   {
HITCBC 134   8 token_ = env->stop_token; 134   8 token_ = env->stop_token;
HITCBC 135   24 return acc_.get_impl().accept( 135   24 return acc_.get_impl().accept(
HITCBC 136   24 h, env->executor, token_, &ec_, &peer_impl_); 136   24 h, env->executor, token_, &ec_, &peer_impl_);
137   } 137   }
138   }; 138   };
139   139  
140   public: 140   public:
141   /** Construct a native acceptor from an execution context. 141   /** Construct a native acceptor from an execution context.
142   142  
143   @param ctx The execution context that will own this acceptor. 143   @param ctx The execution context that will own this acceptor.
144   */ 144   */
HITCBC 145   18 explicit native_tcp_acceptor(capy::execution_context& ctx) 145   18 explicit native_tcp_acceptor(capy::execution_context& ctx)
HITCBC 146   18 : tcp_acceptor(create_handle<service_type>(ctx)) 146   18 : tcp_acceptor(create_handle<service_type>(ctx))
147   { 147   {
HITCBC 148   18 } 148   18 }
149   149  
150   /** Construct a native acceptor from an executor. 150   /** Construct a native acceptor from an executor.
151   151  
152   @param ex The executor whose context will own the acceptor. 152   @param ex The executor whose context will own the acceptor.
153   */ 153   */
154   template<class Ex> 154   template<class Ex>
155   requires(!std::same_as<std::remove_cvref_t<Ex>, native_tcp_acceptor>) && 155   requires(!std::same_as<std::remove_cvref_t<Ex>, native_tcp_acceptor>) &&
156   capy::Executor<Ex> 156   capy::Executor<Ex>
157   explicit native_tcp_acceptor(Ex const& ex) 157   explicit native_tcp_acceptor(Ex const& ex)
158   : native_tcp_acceptor(ex.context()) 158   : native_tcp_acceptor(ex.context())
159   { 159   {
160   } 160   }
161   161  
162   /** Move construct. 162   /** Move construct.
163   163  
164   @param other The acceptor to move from. 164   @param other The acceptor to move from.
165   165  
166   @pre No awaitables returned by @p other's methods exist. 166   @pre No awaitables returned by @p other's methods exist.
167   @pre The execution context associated with @p other must 167   @pre The execution context associated with @p other must
168   outlive this acceptor. 168   outlive this acceptor.
169   */ 169   */
HITCBC 170   2 native_tcp_acceptor(native_tcp_acceptor&&) noexcept = default; 170   2 native_tcp_acceptor(native_tcp_acceptor&&) noexcept = default;
171   171  
172   /** Move assign. 172   /** Move assign.
173   173  
174   @param other The acceptor to move from. 174   @param other The acceptor to move from.
175   175  
176   @pre No awaitables returned by either `*this` or @p other's 176   @pre No awaitables returned by either `*this` or @p other's
177   methods exist. 177   methods exist.
178   @pre The execution context associated with @p other must 178   @pre The execution context associated with @p other must
179   outlive this acceptor. 179   outlive this acceptor.
180   */ 180   */
181   native_tcp_acceptor& operator=(native_tcp_acceptor&&) noexcept = default; 181   native_tcp_acceptor& operator=(native_tcp_acceptor&&) noexcept = default;
182   182  
183   native_tcp_acceptor(native_tcp_acceptor const&) = delete; 183   native_tcp_acceptor(native_tcp_acceptor const&) = delete;
184   native_tcp_acceptor& operator=(native_tcp_acceptor const&) = delete; 184   native_tcp_acceptor& operator=(native_tcp_acceptor const&) = delete;
185   185  
186   /** Asynchronously accept an incoming connection. 186   /** Asynchronously accept an incoming connection.
187   187  
188   Calls the backend implementation directly, bypassing virtual 188   Calls the backend implementation directly, bypassing virtual
189   dispatch. Otherwise identical to @ref tcp_acceptor::accept. 189   dispatch. Otherwise identical to @ref tcp_acceptor::accept.
190   190  
191   @param peer The socket to receive the accepted connection. 191   @param peer The socket to receive the accepted connection.
192   192  
193   @return An awaitable yielding `io_result<>`. 193   @return An awaitable yielding `io_result<>`.
194   194  
195   @throws std::logic_error if the acceptor is not listening. 195   @throws std::logic_error if the acceptor is not listening.
196   196  
197   Both this acceptor and @p peer must outlive the returned 197   Both this acceptor and @p peer must outlive the returned
198   awaitable. 198   awaitable.
199   */ 199   */
HITCBC 200   8 auto accept(tcp_socket& peer) 200   8 auto accept(tcp_socket& peer)
201   { 201   {
HITCBC 202   8 if (!is_open()) 202   8 if (!is_open())
MISUBC 203   ✗ detail::throw_logic_error("accept: acceptor not listening"); 203   ✗ detail::throw_logic_error("accept: acceptor not listening");
HITCBC 204   8 return native_accept_awaitable(*this, peer); 204   8 return native_accept_awaitable(*this, peer);
205   } 205   }
206   206  
207   /** Asynchronously wait for the acceptor to be ready. 207   /** Asynchronously wait for the acceptor to be ready.
208   208  
209   Calls the backend implementation directly, bypassing virtual 209   Calls the backend implementation directly, bypassing virtual
210   dispatch. Otherwise identical to @ref tcp_acceptor::wait. 210   dispatch. Otherwise identical to @ref tcp_acceptor::wait.
211   211  
212   @param w The wait direction (typically `wait_type::read`). 212   @param w The wait direction (typically `wait_type::read`).
213   213  
214   @return An awaitable yielding `io_result<>`. 214   @return An awaitable yielding `io_result<>`.
215   */ 215   */
HITCBC 216   2 [[nodiscard]] auto wait(wait_type w) 216   2 [[nodiscard]] auto wait(wait_type w)
217   { 217   {
HITCBC 218   2 return native_wait_awaitable(*this, w); 218   2 return native_wait_awaitable(*this, w);
219   } 219   }
220   }; 220   };
221   221  
222   } // namespace boost::corosio 222   } // namespace boost::corosio
223   223  
224   #endif 224   #endif