. /include/boost/corosio /native /native_resolver.hpp
100.00% Lines (22/22) 100.00% Functions (7/7)
[ ] 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   // Copyright (c) 2026 Michael Vandeberg 3   // Copyright (c) 2026 Michael Vandeberg
4   // 4   //
5   // Distributed under the Boost Software License, Version 1.0. (See accompanying 5   // Distributed under the Boost Software License, Version 1.0. (See accompanying
6   // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 6   // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
7   // 7   //
8   // Official repository: https://github.com/cppalliance/corosio 8   // Official repository: https://github.com/cppalliance/corosio
9   // 9   //
10   10  
11   #ifndef BOOST_COROSIO_NATIVE_NATIVE_RESOLVER_HPP 11   #ifndef BOOST_COROSIO_NATIVE_NATIVE_RESOLVER_HPP
12   #define BOOST_COROSIO_NATIVE_NATIVE_RESOLVER_HPP 12   #define BOOST_COROSIO_NATIVE_NATIVE_RESOLVER_HPP
13   13  
14   #include <boost/corosio/resolver.hpp> 14   #include <boost/corosio/resolver.hpp>
15   #include <boost/corosio/backend.hpp> 15   #include <boost/corosio/backend.hpp>
16   16  
17   #ifndef BOOST_COROSIO_MRDOCS 17   #ifndef BOOST_COROSIO_MRDOCS
18   #if BOOST_COROSIO_HAS_EPOLL || BOOST_COROSIO_HAS_SELECT || \ 18   #if BOOST_COROSIO_HAS_EPOLL || BOOST_COROSIO_HAS_SELECT || \
19   BOOST_COROSIO_HAS_KQUEUE 19   BOOST_COROSIO_HAS_KQUEUE
20   #include <boost/corosio/native/detail/posix/posix_resolver_service.hpp> 20   #include <boost/corosio/native/detail/posix/posix_resolver_service.hpp>
21   #endif 21   #endif
22   22  
23   #if BOOST_COROSIO_HAS_IOCP 23   #if BOOST_COROSIO_HAS_IOCP
24   #include <boost/corosio/native/detail/iocp/win_resolver_service.hpp> 24   #include <boost/corosio/native/detail/iocp/win_resolver_service.hpp>
25   #endif 25   #endif
26   #endif // !BOOST_COROSIO_MRDOCS 26   #endif // !BOOST_COROSIO_MRDOCS
27   27  
28   namespace boost::corosio { 28   namespace boost::corosio {
29   29  
30   /** An asynchronous DNS resolver with devirtualized operations. 30   /** An asynchronous DNS resolver with devirtualized operations.
31   31  
32   This class template inherits from @ref resolver and shadows 32   This class template inherits from @ref resolver and shadows
33   the `resolve` operations with versions that call the backend 33   the `resolve` operations with versions that call the backend
34   implementation directly, allowing the compiler to inline 34   implementation directly, allowing the compiler to inline
35   through the entire call chain. 35   through the entire call chain.
36   36  
37   Non-async operations (`cancel`) remain unchanged and dispatch 37   Non-async operations (`cancel`) remain unchanged and dispatch
38   through the compiled library. 38   through the compiled library.
39   39  
40   A `native_resolver` IS-A `resolver` and can be passed to any 40   A `native_resolver` IS-A `resolver` and can be passed to any
41   function expecting `resolver&`. 41   function expecting `resolver&`.
42   42  
43   @tparam Backend A backend tag value (e.g., `epoll`). 43   @tparam Backend A backend tag value (e.g., `epoll`).
44   44  
45   @par Thread Safety 45   @par Thread Safety
46   Same as @ref resolver. 46   Same as @ref resolver.
47   47  
48   @see resolver, epoll_t, iocp_t 48   @see resolver, epoll_t, iocp_t
49   */ 49   */
50   template<auto Backend> 50   template<auto Backend>
51   class native_resolver : public resolver 51   class native_resolver : public resolver
52   { 52   {
53   using backend_type = decltype(Backend); 53   using backend_type = decltype(Backend);
54   using impl_type = typename backend_type::resolver_type; 54   using impl_type = typename backend_type::resolver_type;
55   55  
HITCBC 56   4 impl_type& get_impl() noexcept 56   4 impl_type& get_impl() noexcept
57   { 57   {
HITCBC 58   4 return *static_cast<impl_type*>(h_.get()); 58   4 return *static_cast<impl_type*>(h_.get());
59   } 59   }
60   60  
61   struct native_resolve_awaitable 61   struct native_resolve_awaitable
62   { 62   {
63   native_resolver& self_; 63   native_resolver& self_;
64   std::string host_; 64   std::string host_;
65   std::string service_; 65   std::string service_;
66   resolve_flags flags_; 66   resolve_flags flags_;
67   std::stop_token token_; 67   std::stop_token token_;
68   mutable std::error_code ec_; 68   mutable std::error_code ec_;
69   mutable resolver_results results_; 69   mutable resolver_results results_;
70   70  
HITCBC 71   4 native_resolve_awaitable( 71   4 native_resolve_awaitable(
72   native_resolver& self, 72   native_resolver& self,
73   std::string_view host, 73   std::string_view host,
74   std::string_view service, 74   std::string_view service,
75   resolve_flags flags) noexcept 75   resolve_flags flags) noexcept
HITCBC 76   4 : self_(self) 76   4 : self_(self)
HITCBC 77   8 , host_(host) 77   8 , host_(host)
HITCBC 78   8 , service_(service) 78   8 , service_(service)
HITCBC 79   4 , flags_(flags) 79   4 , flags_(flags)
80   { 80   {
HITCBC 81   4 } 81   4 }
82   82  
HITCBC 83   4 bool await_ready() const noexcept 83   4 bool await_ready() const noexcept
84   { 84   {
HITCBC 85   4 return static_cast<bool>(ec_) || token_.stop_requested(); 85   4 return static_cast<bool>(ec_) || token_.stop_requested();
86   } 86   }
87   87  
HITGIC 88 - [[nodiscard]] capy::io_result<resolver_results> 88 + 4 [[nodiscard]] capy::io_result<resolver_results> await_resume() const noexcept
DCB 89 - 4 await_resume() const noexcept  
90   { 89   {
HITCBC 91   4 if (token_.stop_requested()) 90   4 if (token_.stop_requested())
HITCBC 92   2 return {make_error_code(std::errc::operation_canceled), {}}; 91   2 return {make_error_code(std::errc::operation_canceled), {}};
HITCBC 93   2 return {ec_, std::move(results_)}; 92   2 return {ec_, std::move(results_)};
94   } 93   }
95   94  
HITCBC 96   4 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 95   4 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
97   -> std::coroutine_handle<> 96   -> std::coroutine_handle<>
98   { 97   {
HITCBC 99   4 token_ = env->stop_token; 98   4 token_ = env->stop_token;
HITCBC 100   12 return self_.get_impl().resolve( 99   12 return self_.get_impl().resolve(
HITCBC 101   4 h, env->executor, host_, service_, flags_, token_, &ec_, 100   4 h, env->executor, host_, service_, flags_, token_, &ec_,
HITCBC 102   8 &results_); 101   8 &results_);
103   } 102   }
104   }; 103   };
105   104  
106   struct native_reverse_awaitable 105   struct native_reverse_awaitable
107   { 106   {
108   native_resolver& self_; 107   native_resolver& self_;
109   endpoint ep_; 108   endpoint ep_;
110   reverse_flags flags_; 109   reverse_flags flags_;
111   std::stop_token token_; 110   std::stop_token token_;
112   mutable std::error_code ec_; 111   mutable std::error_code ec_;
113   mutable reverse_resolver_result result_; 112   mutable reverse_resolver_result result_;
114   113  
115   native_reverse_awaitable( 114   native_reverse_awaitable(
116   native_resolver& self, 115   native_resolver& self,
117   endpoint const& ep, 116   endpoint const& ep,
118   reverse_flags flags) noexcept 117   reverse_flags flags) noexcept
119   : self_(self) 118   : self_(self)
120   , ep_(ep) 119   , ep_(ep)
121   , flags_(flags) 120   , flags_(flags)
122   { 121   {
123   } 122   }
124   123  
125   bool await_ready() const noexcept 124   bool await_ready() const noexcept
126   { 125   {
127   return static_cast<bool>(ec_) || token_.stop_requested(); 126   return static_cast<bool>(ec_) || token_.stop_requested();
128   } 127   }
129   128  
130 - [[nodiscard]] capy::io_result<reverse_resolver_result> 129 + [[nodiscard]] capy::io_result<reverse_resolver_result> await_resume() const noexcept
131 - await_resume() const noexcept  
132   { 130   {
133   if (token_.stop_requested()) 131   if (token_.stop_requested())
134   return {make_error_code(std::errc::operation_canceled), {}}; 132   return {make_error_code(std::errc::operation_canceled), {}};
135   return {ec_, std::move(result_)}; 133   return {ec_, std::move(result_)};
136   } 134   }
137   135  
138   auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 136   auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
139   -> std::coroutine_handle<> 137   -> std::coroutine_handle<>
140   { 138   {
141   token_ = env->stop_token; 139   token_ = env->stop_token;
142   return self_.get_impl().reverse_resolve( 140   return self_.get_impl().reverse_resolve(
143   h, env->executor, ep_, flags_, token_, &ec_, &result_); 141   h, env->executor, ep_, flags_, token_, &ec_, &result_);
144   } 142   }
145   }; 143   };
146   144  
147   public: 145   public:
148   /** Construct a native resolver from an execution context. 146   /** Construct a native resolver from an execution context.
149   147  
150   @param ctx The execution context that will own this resolver. 148   @param ctx The execution context that will own this resolver.
151   */ 149   */
HITCBC 152   8 explicit native_resolver(capy::execution_context& ctx) : resolver(ctx) {} 150   8 explicit native_resolver(capy::execution_context& ctx) : resolver(ctx) {}
153   151  
154   /** Construct a native resolver from an executor. 152   /** Construct a native resolver from an executor.
155   153  
156   @param ex The executor whose context will own the resolver. 154   @param ex The executor whose context will own the resolver.
157   */ 155   */
158   template<class Ex> 156   template<class Ex>
159   requires(!std::same_as<std::remove_cvref_t<Ex>, native_resolver>) && 157   requires(!std::same_as<std::remove_cvref_t<Ex>, native_resolver>) &&
160   capy::Executor<Ex> 158   capy::Executor<Ex>
161   explicit native_resolver(Ex const& ex) : native_resolver(ex.context()) 159   explicit native_resolver(Ex const& ex) : native_resolver(ex.context())
162   { 160   {
163   } 161   }
164   162  
165   /** Move construct. 163   /** Move construct.
166   164  
167   @pre No awaitables returned by @p other's `resolve` methods 165   @pre No awaitables returned by @p other's `resolve` methods
168   exist. 166   exist.
169   @pre The execution context associated with @p other must 167   @pre The execution context associated with @p other must
170   outlive this resolver. 168   outlive this resolver.
171   */ 169   */
172   native_resolver(native_resolver&&) noexcept = default; 170   native_resolver(native_resolver&&) noexcept = default;
173   171  
174   /** Move assign. 172   /** Move assign.
175   173  
176   @pre No awaitables returned by either `*this` or the source's 174   @pre No awaitables returned by either `*this` or the source's
177   `resolve` methods exist. 175   `resolve` methods exist.
178   @pre The execution context associated with the source must 176   @pre The execution context associated with the source must
179   outlive this resolver. 177   outlive this resolver.
180   */ 178   */
181   native_resolver& operator=(native_resolver&&) noexcept = default; 179   native_resolver& operator=(native_resolver&&) noexcept = default;
182   180  
183   native_resolver(native_resolver const&) = delete; 181   native_resolver(native_resolver const&) = delete;
184   native_resolver& operator=(native_resolver const&) = delete; 182   native_resolver& operator=(native_resolver const&) = delete;
185   183  
186   /** Asynchronously resolve a host and service to endpoints. 184   /** Asynchronously resolve a host and service to endpoints.
187   185  
188   Calls the backend implementation directly, bypassing virtual 186   Calls the backend implementation directly, bypassing virtual
189   dispatch. Otherwise identical to @ref resolver::resolve. 187   dispatch. Otherwise identical to @ref resolver::resolve.
190   188  
191   This resolver must outlive the returned awaitable. 189   This resolver must outlive the returned awaitable.
192   190  
193   @param host The host name or address string. 191   @param host The host name or address string.
194   @param service The service name or port string. 192   @param service The service name or port string.
195   193  
196   @return An awaitable yielding `io_result<resolver_results>`. 194   @return An awaitable yielding `io_result<resolver_results>`.
197   195  
198   @note `resolver_results` is an alias for `std::vector<resolver_entry>`; 196   @note `resolver_results` is an alias for `std::vector<resolver_entry>`;
199   copying it deep-copies every entry. See @ref resolver::resolve. 197   copying it deep-copies every entry. See @ref resolver::resolve.
200   */ 198   */
HITCBC 201   4 [[nodiscard]] auto resolve(std::string_view host, std::string_view service) 199   4 [[nodiscard]] auto resolve(std::string_view host, std::string_view service)
202   { 200   {
203   return native_resolve_awaitable( 201   return native_resolve_awaitable(
HITCBC 204   4 *this, host, service, resolve_flags::none); 202   4 *this, host, service, resolve_flags::none);
205   } 203   }
206   204  
207   /** Asynchronously resolve a host and service with flags. 205   /** Asynchronously resolve a host and service with flags.
208   206  
209   This resolver must outlive the returned awaitable. 207   This resolver must outlive the returned awaitable.
210   208  
211   @param host The host name or address string. 209   @param host The host name or address string.
212   @param service The service name or port string. 210   @param service The service name or port string.
213   @param flags Flags controlling resolution behavior. 211   @param flags Flags controlling resolution behavior.
214   212  
215   @return An awaitable yielding `io_result<resolver_results>`. 213   @return An awaitable yielding `io_result<resolver_results>`.
216   */ 214   */
217   [[nodiscard]] auto resolve( 215   [[nodiscard]] auto resolve(
218   std::string_view host, std::string_view service, resolve_flags flags) 216   std::string_view host, std::string_view service, resolve_flags flags)
219   { 217   {
220   return native_resolve_awaitable(*this, host, service, flags); 218   return native_resolve_awaitable(*this, host, service, flags);
221   } 219   }
222   220  
223   /** Asynchronously reverse-resolve an endpoint. 221   /** Asynchronously reverse-resolve an endpoint.
224   222  
225   Calls the backend implementation directly, bypassing virtual 223   Calls the backend implementation directly, bypassing virtual
226   dispatch. Otherwise identical to the endpoint overload of 224   dispatch. Otherwise identical to the endpoint overload of
227   @ref resolver::resolve. 225   @ref resolver::resolve.
228   226  
229   This resolver must outlive the returned awaitable. 227   This resolver must outlive the returned awaitable.
230   228  
231   @param ep The endpoint to resolve. 229   @param ep The endpoint to resolve.
232   230  
233   @return An awaitable yielding 231   @return An awaitable yielding
234   `io_result<reverse_resolver_result>`. 232   `io_result<reverse_resolver_result>`.
235   */ 233   */
236   [[nodiscard]] auto resolve(endpoint const& ep) 234   [[nodiscard]] auto resolve(endpoint const& ep)
237   { 235   {
238   return native_reverse_awaitable(*this, ep, reverse_flags::none); 236   return native_reverse_awaitable(*this, ep, reverse_flags::none);
239   } 237   }
240   238  
241   /** Asynchronously reverse-resolve an endpoint with flags. 239   /** Asynchronously reverse-resolve an endpoint with flags.
242   240  
243   This resolver must outlive the returned awaitable. 241   This resolver must outlive the returned awaitable.
244   242  
245   @param ep The endpoint to resolve. 243   @param ep The endpoint to resolve.
246   @param flags Flags controlling resolution behavior. 244   @param flags Flags controlling resolution behavior.
247   245  
248   @return An awaitable yielding 246   @return An awaitable yielding
249   `io_result<reverse_resolver_result>`. 247   `io_result<reverse_resolver_result>`.
250   */ 248   */
251   [[nodiscard]] auto resolve(endpoint const& ep, reverse_flags flags) 249   [[nodiscard]] auto resolve(endpoint const& ep, reverse_flags flags)
252   { 250   {
253   return native_reverse_awaitable(*this, ep, flags); 251   return native_reverse_awaitable(*this, ep, flags);
254   } 252   }
255   }; 253   };
256   254  
257   } // namespace boost::corosio 255   } // namespace boost::corosio
258   256  
259   #endif 257   #endif