. /include/boost/corosio /native /native_tcp_acceptor.hpp
94.03% Lines (63/67) 100.00% Functions (18/18)
[ ] 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   32  
33   #if BOOST_COROSIO_HAS_IO_URING 33   #if BOOST_COROSIO_HAS_IO_URING
34   #include <boost/corosio/native/detail/io_uring/io_uring_types.hpp> 34   #include <boost/corosio/native/detail/io_uring/io_uring_types.hpp>
35   #endif 35   #endif
36   #endif // !BOOST_COROSIO_MRDOCS 36   #endif // !BOOST_COROSIO_MRDOCS
37   37  
38   namespace boost::corosio { 38   namespace boost::corosio {
39   39  
40   /** An asynchronous TCP acceptor with devirtualized accept operations. 40   /** An asynchronous TCP acceptor with devirtualized accept operations.
41   41  
42   This class template inherits from @ref tcp_acceptor and shadows 42   This class template inherits from @ref tcp_acceptor and shadows
43   the `accept` operation with a version that calls the backend 43   the `accept` operation with a version that calls the backend
44   implementation directly, allowing the compiler to inline through 44   implementation directly, allowing the compiler to inline through
45   the entire call chain. 45   the entire call chain.
46   46  
47   Non-async operations (`listen`, `close`, `cancel`) remain 47   Non-async operations (`listen`, `close`, `cancel`) remain
48   unchanged and dispatch through the compiled library. 48   unchanged and dispatch through the compiled library.
49   49  
50   A `native_tcp_acceptor` IS-A `tcp_acceptor` and can be passed 50   A `native_tcp_acceptor` IS-A `tcp_acceptor` and can be passed
51   to any function expecting `tcp_acceptor&`. 51   to any function expecting `tcp_acceptor&`.
52   52  
53   @tparam Backend A backend tag value (e.g., `epoll`). 53   @tparam Backend A backend tag value (e.g., `epoll`).
54   54  
55   @par Thread Safety 55   @par Thread Safety
56   Same as @ref tcp_acceptor. 56   Same as @ref tcp_acceptor.
57   57  
58   @see tcp_acceptor, epoll_t, iocp_t 58   @see tcp_acceptor, epoll_t, iocp_t
59   */ 59   */
60   template<auto Backend> 60   template<auto Backend>
61   class native_tcp_acceptor : public tcp_acceptor 61   class native_tcp_acceptor : public tcp_acceptor
62   { 62   {
63   using backend_type = decltype(Backend); 63   using backend_type = decltype(Backend);
64   using impl_type = typename backend_type::tcp_acceptor_type; 64   using impl_type = typename backend_type::tcp_acceptor_type;
65   using service_type = typename backend_type::tcp_acceptor_service_type; 65   using service_type = typename backend_type::tcp_acceptor_service_type;
66   66  
HITCBC 67   13 impl_type& get_impl() noexcept 67   15 impl_type& get_impl() noexcept
68   { 68   {
HITCBC 69   13 return *static_cast<impl_type*>(h_.get()); 69   15 return *static_cast<impl_type*>(h_.get());
70   } 70   }
71   71  
72   struct native_wait_awaitable 72   struct native_wait_awaitable
73   { 73   {
74   native_tcp_acceptor& acc_; 74   native_tcp_acceptor& acc_;
75   wait_type w_; 75   wait_type w_;
76   std::stop_token token_; 76   std::stop_token token_;
77   mutable std::error_code ec_; 77   mutable std::error_code ec_;
78   78  
HITCBC 79   2 native_wait_awaitable(native_tcp_acceptor& acc, wait_type w) noexcept 79   4 native_wait_awaitable(native_tcp_acceptor& acc, wait_type w) noexcept
HITCBC 80   2 : acc_(acc) 80   4 : acc_(acc)
HITCBC 81   2 , w_(w) 81   4 , w_(w)
82   { 82   {
HITCBC 83   2 } 83   4 }
84   84  
HITCBC 85   2 bool await_ready() const noexcept 85   4 bool await_ready() const noexcept
86   { 86   {
ECB 87 - 2 return token_.stop_requested(); 87 + // A pre-set ec_ means the initiator failed before
  88 + // dispatch (e.g. a closed object).
HITGNC   89 + 4 return static_cast<bool>(ec_) || token_.stop_requested();
88   } 90   }
89   91  
HITCBC 90   2 [[nodiscard]] capy::io_result<> await_resume() const noexcept 92   4 [[nodiscard]] capy::io_result<> await_resume() const noexcept
91   { 93   {
HITCBC 92   2 if (token_.stop_requested()) 94   4 if (token_.stop_requested())
MISUBC 93   ✗ return {make_error_code(std::errc::operation_canceled)}; 95   ✗ return {make_error_code(std::errc::operation_canceled)};
HITCBC 94   2 return {ec_}; 96   4 return {ec_};
95   } 97   }
96   98  
HITCBC 97   2 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 99   4 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
98   -> std::coroutine_handle<> 100   -> std::coroutine_handle<>
99   { 101   {
HITCBC 100   2 token_ = env->stop_token; 102   4 token_ = env->stop_token;
HITCBC 101   6 return acc_.get_impl().wait( 103   12 return acc_.get_impl().wait(
HITCBC 102   6 h, env->executor, w_, token_, &ec_); 104   12 h, env->executor, w_, token_, &ec_);
103   } 105   }
104   }; 106   };
105   107  
106   struct native_accept_awaitable 108   struct native_accept_awaitable
107   { 109   {
108   native_tcp_acceptor& acc_; 110   native_tcp_acceptor& acc_;
109   tcp_socket& peer_; 111   tcp_socket& peer_;
110   std::stop_token token_; 112   std::stop_token token_;
111   mutable std::error_code ec_; 113   mutable std::error_code ec_;
112   mutable io_object::implementation* peer_impl_ = nullptr; 114   mutable io_object::implementation* peer_impl_ = nullptr;
113   115  
HITCBC 114   9 native_accept_awaitable( 116   11 native_accept_awaitable(
115   native_tcp_acceptor& acc, tcp_socket& peer) noexcept 117   native_tcp_acceptor& acc, tcp_socket& peer) noexcept
HITCBC 116   9 : acc_(acc) 118   11 : acc_(acc)
HITCBC 117   9 , peer_(peer) 119   11 , peer_(peer)
118   { 120   {
HITCBC 119   9 } 121   11 }
120   122  
HITCBC 121   9 bool await_ready() const noexcept 123   11 bool await_ready() const noexcept
122   { 124   {
ECB 123 - 9 return token_.stop_requested(); 125 + // A pre-set ec_ means the initiator failed before
  126 + // dispatch (e.g. a closed object).
HITGNC   127 + 11 return static_cast<bool>(ec_) || token_.stop_requested();
124   } 128   }
125   129  
HITCBC 126   9 [[nodiscard]] capy::io_result<> await_resume() const noexcept 130   11 [[nodiscard]] capy::io_result<> await_resume() const noexcept
127   { 131   {
HITCBC 128   9 if (token_.stop_requested()) 132   11 if (token_.stop_requested())
MISUBC 129   ✗ return {make_error_code(std::errc::operation_canceled)}; 133   ✗ return {make_error_code(std::errc::operation_canceled)};
HITCBC 130   9 if (!ec_) 134   11 if (!ec_)
HITCBC 131   9 acc_.reset_peer_impl(peer_, peer_impl_); 135   9 acc_.reset_peer_impl(peer_, peer_impl_);
HITCBC 132   9 return {ec_}; 136   11 return {ec_};
133   } 137   }
134   138  
HITCBC 135   9 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 139   9 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
136   -> std::coroutine_handle<> 140   -> std::coroutine_handle<>
137   { 141   {
HITCBC 138   9 token_ = env->stop_token; 142   9 token_ = env->stop_token;
HITCBC 139   27 return acc_.get_impl().accept( 143   27 return acc_.get_impl().accept(
HITCBC 140   27 h, env->executor, token_, &ec_, &peer_impl_); 144   27 h, env->executor, token_, &ec_, &peer_impl_);
141   } 145   }
142   }; 146   };
143   147  
144   struct native_accept_value_awaitable 148   struct native_accept_value_awaitable
145   { 149   {
146   native_tcp_acceptor& acc_; 150   native_tcp_acceptor& acc_;
147   tcp_socket peer_; 151   tcp_socket peer_;
148   std::stop_token token_; 152   std::stop_token token_;
149   mutable std::error_code ec_; 153   mutable std::error_code ec_;
150   mutable io_object::implementation* peer_impl_ = nullptr; 154   mutable io_object::implementation* peer_impl_ = nullptr;
151   155  
HITCBC 152   2 explicit native_accept_value_awaitable(native_tcp_acceptor& acc) 156   4 explicit native_accept_value_awaitable(native_tcp_acceptor& acc)
HITCBC 153   2 : acc_(acc) 157   4 : acc_(acc)
HITCBC 154   2 , peer_(acc.context()) 158   4 , peer_(acc.context())
155   { 159   {
HITCBC 156   2 } 160   4 }
157   161  
HITCBC 158   2 bool await_ready() const noexcept 162   4 bool await_ready() const noexcept
159   { 163   {
ECB 160 - 2 return token_.stop_requested(); 164 + // A pre-set ec_ means the initiator failed before
  165 + // dispatch (e.g. a closed object).
HITGNC   166 + 4 return static_cast<bool>(ec_) || token_.stop_requested();
161   } 167   }
162   168  
HITCBC 163   2 [[nodiscard]] capy::io_result<tcp_socket> await_resume() noexcept 169   4 [[nodiscard]] capy::io_result<tcp_socket> await_resume() noexcept
164   { 170   {
HITCBC 165   2 if (token_.stop_requested()) 171   4 if (token_.stop_requested())
MISUBC 166   ✗ return {make_error_code(std::errc::operation_canceled), 172   ✗ return {make_error_code(std::errc::operation_canceled),
MISUBC 167   ✗ std::move(peer_)}; 173   ✗ std::move(peer_)};
HITCBC 168   2 if (!ec_ && peer_impl_) 174   4 if (!ec_ && peer_impl_)
HITCBC 169   2 acc_.reset_peer_impl(peer_, peer_impl_); 175   2 acc_.reset_peer_impl(peer_, peer_impl_);
HITCBC 170   2 return {ec_, std::move(peer_)}; 176   4 return {ec_, std::move(peer_)};
171   } 177   }
172   178  
HITCBC 173   2 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 179   2 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
174   -> std::coroutine_handle<> 180   -> std::coroutine_handle<>
175   { 181   {
HITCBC 176   2 token_ = env->stop_token; 182   2 token_ = env->stop_token;
HITCBC 177   6 return acc_.get_impl().accept( 183   6 return acc_.get_impl().accept(
HITCBC 178   6 h, env->executor, token_, &ec_, &peer_impl_); 184   6 h, env->executor, token_, &ec_, &peer_impl_);
179   } 185   }
180   }; 186   };
181   187  
182   public: 188   public:
183   /** Construct a native acceptor from an execution context. 189   /** Construct a native acceptor from an execution context.
184   190  
185   @param ctx The execution context that will own this acceptor. 191   @param ctx The execution context that will own this acceptor.
186   */ 192   */
HITCBC 187   21 explicit native_tcp_acceptor(capy::execution_context& ctx) 193   27 explicit native_tcp_acceptor(capy::execution_context& ctx)
HITCBC 188   21 : tcp_acceptor(create_handle<service_type>(ctx)) 194   27 : tcp_acceptor(create_handle<service_type>(ctx))
189   { 195   {
HITCBC 190   21 } 196   27 }
191   197  
192   /** Construct a native acceptor from an executor. 198   /** Construct a native acceptor from an executor.
193   199  
194   @param ex The executor whose context will own the acceptor. 200   @param ex The executor whose context will own the acceptor.
195   */ 201   */
196   template<class Ex> 202   template<class Ex>
197   requires(!std::same_as<std::remove_cvref_t<Ex>, native_tcp_acceptor>) && 203   requires(!std::same_as<std::remove_cvref_t<Ex>, native_tcp_acceptor>) &&
198   capy::Executor<Ex> 204   capy::Executor<Ex>
199   explicit native_tcp_acceptor(Ex const& ex) 205   explicit native_tcp_acceptor(Ex const& ex)
200   : native_tcp_acceptor(ex.context()) 206   : native_tcp_acceptor(ex.context())
201   { 207   {
202   } 208   }
203   209  
204   /** Move construct. 210   /** Move construct.
205   211  
206   @param other The acceptor to move from. 212   @param other The acceptor to move from.
207   213  
208   @pre No awaitables returned by @p other's methods exist. 214   @pre No awaitables returned by @p other's methods exist.
209   @pre The execution context associated with @p other must 215   @pre The execution context associated with @p other must
210   outlive this acceptor. 216   outlive this acceptor.
211   */ 217   */
HITCBC 212   2 native_tcp_acceptor(native_tcp_acceptor&&) noexcept = default; 218   4 native_tcp_acceptor(native_tcp_acceptor&&) noexcept = default;
213   219  
214   /** Move assign. 220   /** Move assign.
215   221  
216   @param other The acceptor to move from. 222   @param other The acceptor to move from.
217   223  
218   @pre No awaitables returned by either `*this` or @p other's 224   @pre No awaitables returned by either `*this` or @p other's
219   methods exist. 225   methods exist.
220   @pre The execution context associated with @p other must 226   @pre The execution context associated with @p other must
221   outlive this acceptor. 227   outlive this acceptor.
222   */ 228   */
223   native_tcp_acceptor& operator=(native_tcp_acceptor&&) noexcept = default; 229   native_tcp_acceptor& operator=(native_tcp_acceptor&&) noexcept = default;
224   230  
225   native_tcp_acceptor(native_tcp_acceptor const&) = delete; 231   native_tcp_acceptor(native_tcp_acceptor const&) = delete;
226   native_tcp_acceptor& operator=(native_tcp_acceptor const&) = delete; 232   native_tcp_acceptor& operator=(native_tcp_acceptor const&) = delete;
227   233  
228   /** Asynchronously accept an incoming connection. 234   /** Asynchronously accept an incoming connection.
229   235  
230   Calls the backend implementation directly, bypassing virtual 236   Calls the backend implementation directly, bypassing virtual
231   dispatch. Otherwise identical to @ref tcp_acceptor::accept. 237   dispatch. Otherwise identical to @ref tcp_acceptor::accept.
232   238  
233   @param peer The socket to receive the accepted connection. 239   @param peer The socket to receive the accepted connection.
234   240  
235   @return An awaitable yielding `io_result<>`. 241   @return An awaitable yielding `io_result<>`.
236   242  
237 - @throws std::logic_error if the acceptor is not listening. 243 + A closed acceptor reports `errc::bad_file_descriptor`.
238   244  
239   Both this acceptor and @p peer must outlive the returned 245   Both this acceptor and @p peer must outlive the returned
240   awaitable. 246   awaitable.
241   */ 247   */
HITCBC 242 - 9 auto accept(tcp_socket& peer) 248 + 11 [[nodiscard]] auto accept(tcp_socket& peer)
243   { 249   {
HITGNC   250 + 11 native_accept_awaitable aw(*this, peer);
HITCBC 244   9 if (!is_open()) 251   11 if (!is_open())
HITGBC 245 - ✗ detail::throw_logic_error("accept: acceptor not listening"); 252 + 2 aw.ec_ = make_error_code(std::errc::bad_file_descriptor);
HITCBC 246 - 9 return native_accept_awaitable(*this, peer); 253 + 11 return aw;
247   } 254   }
248   255  
249   /** Asynchronously accept an incoming connection, returning the peer. 256   /** Asynchronously accept an incoming connection, returning the peer.
250   257  
251   Calls the backend implementation directly, bypassing virtual 258   Calls the backend implementation directly, bypassing virtual
252   dispatch. Otherwise identical to @ref tcp_acceptor::accept(). 259   dispatch. Otherwise identical to @ref tcp_acceptor::accept().
253   260  
254   @return An awaitable yielding `io_result<tcp_socket>`. 261   @return An awaitable yielding `io_result<tcp_socket>`.
255   262  
256 - @throws std::logic_error if the acceptor is not listening. 263 + A closed acceptor reports `errc::bad_file_descriptor`.
  264 +
  265 + @throws std::logic_error If the acceptor has been moved from.
257   266  
258   This acceptor must outlive the returned awaitable. 267   This acceptor must outlive the returned awaitable.
259   */ 268   */
HITCBC 260 - 2 auto accept() 269 + 6 [[nodiscard]] auto accept()
261   { 270   {
  271 + // The awaitable builds the peer from context(), which a
  272 + // moved-from acceptor no longer has.
HITGNC   273 + 6 if (!h_)
HITGNC   274 + 2 detail::throw_logic_error("accept: acceptor moved-from");
HITGNC   275 + 4 native_accept_value_awaitable aw(*this);
HITCBC 262   2 if (!is_open()) 276   4 if (!is_open())
HITGBC 263 - ✗ detail::throw_logic_error("accept: acceptor not listening"); 277 + 2 aw.ec_ = make_error_code(std::errc::bad_file_descriptor);
HITCBC 264 - 2 return native_accept_value_awaitable(*this); 278 + 4 return aw;
265   } 279   }
266   280  
267   /** Asynchronously wait for the acceptor to be ready. 281   /** Asynchronously wait for the acceptor to be ready.
268   282  
269   Calls the backend implementation directly, bypassing virtual 283   Calls the backend implementation directly, bypassing virtual
270   dispatch. Otherwise identical to @ref tcp_acceptor::wait. 284   dispatch. Otherwise identical to @ref tcp_acceptor::wait.
271   285  
272   @param w The wait direction (typically `wait_type::read`). 286   @param w The wait direction (typically `wait_type::read`).
273   287  
274   @return An awaitable yielding `io_result<>`. 288   @return An awaitable yielding `io_result<>`.
275   */ 289   */
HITCBC 276   2 [[nodiscard]] auto wait(wait_type w) 290   4 [[nodiscard]] auto wait(wait_type w)
277   { 291   {
HITCBC 278   2 return native_wait_awaitable(*this, w); 292   4 return native_wait_awaitable(*this, w);
279   } 293   }
280   }; 294   };
281   295  
282   } // namespace boost::corosio 296   } // namespace boost::corosio
283   297  
284   #endif 298   #endif