include/boost/corosio/native/detail/reactor/reactor_socket_service.hpp

100.0% Lines (32 / 32, 1 excl) 100.0% Functions (85 / 85)

[ ] prev/next file

reactor_socket_service.hpp

f(x) Functions (85)

Function Calls Lines Blocks

Line	Hits	Source Code
1		//
2		// Copyright (c) 2026 Steve Gerbino
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_NATIVE_DETAIL_REACTOR_REACTOR_SOCKET_SERVICE_HPP
11		#define BOOST_COROSIO_NATIVE_DETAIL_REACTOR_REACTOR_SOCKET_SERVICE_HPP
12
13		#include <boost/corosio/io/io_object.hpp>
14		#include <boost/corosio/detail/object_ref.hpp>
15		#include <boost/corosio/detail/scheduler_op.hpp>
16		#include <boost/corosio/native/detail/reactor/reactor_service_state.hpp>
17		#include <boost/capy/ex/execution_context.hpp>
18
19		#include <memory>
20
21		namespace boost::corosio::detail {
22
23		/** CRTP base for reactor-backed socket/datagram service implementations.
24
25		Provides the shared construct/destroy/shutdown/close/post/work
26		logic that is identical across all reactor backends and socket
27		types. Derived classes add only protocol-specific open/bind.
28
29		@tparam Derived The concrete service type (CRTP).
30		@tparam ServiceBase The abstract service base (tcp_service
31		or udp_service).
32		@tparam Scheduler The backend's scheduler type.
33		@tparam Impl The backend's socket/datagram impl type.
34		*/
35		template<class Derived, class ServiceBase, class Scheduler, class Impl>
36		class reactor_socket_service : public ServiceBase
37		{
38		friend Derived;
39
40		// The intermediate CRTP templates below (not Impl itself) are what
41		// actually reach into state_->pool_ from retire() -- see
42		// reactor_socket_finals.hpp.
43		template<class, class, class, class, class, class>
44		friend class reactor_stream_socket_impl;
45		template<class, class, class, class, class, class>
46		friend class reactor_dgram_socket_impl;
47
48		using state_type = reactor_service_state<Scheduler, Impl>;
49
50		protected:
51		// NOLINTNEXTLINE(bugprone-crtp-constructor-accessibility)
52	1858x	explicit reactor_socket_service(capy::execution_context& ctx)
53	1858x	: state_(
54		std::make_unique<state_type>(
55	1858x	ctx.template use_service<Scheduler>()))
56		{
57	1858x	}
58
59		public:
60	1858x	~reactor_socket_service() override = default;
61
62	1858x	void shutdown() override
63		{
64	1858x	state_->pool_.shutdown(
65	1858x	[this](Impl* impl)
66		{
67	39x	static_cast<Derived*>(this)->pre_shutdown(impl);
68	39x	impl->close_socket();
69		});
70
71		// Queued ops still hold references (their own object_ref copy);
72		// the scheduler shuts down after us and drains completed_ops_,
73		// each op's destroy() releasing its reference. Shutting-down
74		// mode makes that final release() delete instead of recycle,
75		// so every impl stays alive until its ops are gone, then frees.
76	1858x	}
77
78	26847x	io_object::implementation* construct() override
79		{
80	26847x	return state_->pool_.acquire(static_cast<Derived&>(*this));
81		}
82
83	26847x	void destroy(io_object::implementation* impl) override
84		{
85	26847x	auto* typed = static_cast<Impl*>(impl);
86	26847x	static_cast<Derived*>(this)->pre_destroy(typed);
87	26847x	typed->close_socket();
88	26847x	release(typed);
89	26847x	}
90
91	46550x	void close(io_object::handle& h) override
92		{
93	46550x	static_cast<Impl*>(h.get())->close_socket();
94	46550x	}
95
96	547323x	Scheduler& scheduler() const noexcept
97		{
98	547323x	return state_->sched_;
99		}
100
101	95294x	void post(scheduler_op* op)
102		{
103	95294x	state_->sched_.post(op);
104	95294x	}
105
106	10253x	void work_started() noexcept
107		{
108	10253x	state_->sched_.work_started();
109	10253x	}
110
111		protected:
112		// Override in derived to add pre-close logic. No backend currently needs
113		// it; the hooks exist so a trait can run fd-level teardown before close.
114	125x	void pre_shutdown(Impl*) noexcept {
115	−	} // LCOV_EXCL_LINE optional CRTP hook; no backend overrides it today
116	1224x	void pre_destroy(Impl*) noexcept {}
117
118		std::unique_ptr<state_type> state_;
119
120		private:
121		reactor_socket_service(reactor_socket_service const&) = delete;
122		reactor_socket_service& operator=(reactor_socket_service const&) = delete;
123		};
124
125		} // namespace boost::corosio::detail
126
127		#endif // BOOST_COROSIO_NATIVE_DETAIL_REACTOR_REACTOR_SOCKET_SERVICE_HPP
128