2 // detail/win_iocp_serial_port_service.hpp
3 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5 // Copyright (c) 2003-2022 Christopher M. Kohlhoff (chris at kohlhoff dot com)
6 // Copyright (c) 2008 Rep Invariant Systems, Inc. (info@repinvariant.com)
8 // Distributed under the Boost Software License, Version 1.0. (See accompanying
9 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
12 #ifndef BOOST_ASIO_DETAIL_WIN_IOCP_SERIAL_PORT_SERVICE_HPP
13 #define BOOST_ASIO_DETAIL_WIN_IOCP_SERIAL_PORT_SERVICE_HPP
15 #if defined(_MSC_VER) && (_MSC_VER >= 1200)
17 #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
19 #include <boost/asio/detail/config.hpp>
21 #if defined(BOOST_ASIO_HAS_IOCP) && defined(BOOST_ASIO_HAS_SERIAL_PORT)
24 #include <boost/asio/error.hpp>
25 #include <boost/asio/execution_context.hpp>
26 #include <boost/asio/detail/win_iocp_handle_service.hpp>
28 #include <boost/asio/detail/push_options.hpp>
34 // Extend win_iocp_handle_service to provide serial port support.
35 class win_iocp_serial_port_service :
36 public execution_context_service_base<win_iocp_serial_port_service>
39 // The native type of a serial port.
40 typedef win_iocp_handle_service::native_handle_type native_handle_type;
42 // The implementation type of the serial port.
43 typedef win_iocp_handle_service::implementation_type implementation_type;
46 BOOST_ASIO_DECL win_iocp_serial_port_service(execution_context& context);
48 // Destroy all user-defined handler objects owned by the service.
49 BOOST_ASIO_DECL void shutdown();
51 // Construct a new serial port implementation.
52 void construct(implementation_type& impl)
54 handle_service_.construct(impl);
57 // Move-construct a new serial port implementation.
58 void move_construct(implementation_type& impl,
59 implementation_type& other_impl)
61 handle_service_.move_construct(impl, other_impl);
64 // Move-assign from another serial port implementation.
65 void move_assign(implementation_type& impl,
66 win_iocp_serial_port_service& other_service,
67 implementation_type& other_impl)
69 handle_service_.move_assign(impl,
70 other_service.handle_service_, other_impl);
73 // Destroy a serial port implementation.
74 void destroy(implementation_type& impl)
76 handle_service_.destroy(impl);
79 // Open the serial port using the specified device name.
80 BOOST_ASIO_DECL boost::system::error_code open(implementation_type& impl,
81 const std::string& device, boost::system::error_code& ec);
83 // Assign a native handle to a serial port implementation.
84 boost::system::error_code assign(implementation_type& impl,
85 const native_handle_type& handle, boost::system::error_code& ec)
87 return handle_service_.assign(impl, handle, ec);
90 // Determine whether the serial port is open.
91 bool is_open(const implementation_type& impl) const
93 return handle_service_.is_open(impl);
96 // Destroy a serial port implementation.
97 boost::system::error_code close(implementation_type& impl,
98 boost::system::error_code& ec)
100 return handle_service_.close(impl, ec);
103 // Get the native serial port representation.
104 native_handle_type native_handle(implementation_type& impl)
106 return handle_service_.native_handle(impl);
109 // Cancel all operations associated with the handle.
110 boost::system::error_code cancel(implementation_type& impl,
111 boost::system::error_code& ec)
113 return handle_service_.cancel(impl, ec);
116 // Set an option on the serial port.
117 template <typename SettableSerialPortOption>
118 boost::system::error_code set_option(implementation_type& impl,
119 const SettableSerialPortOption& option, boost::system::error_code& ec)
121 return do_set_option(impl,
122 &win_iocp_serial_port_service::store_option<SettableSerialPortOption>,
126 // Get an option from the serial port.
127 template <typename GettableSerialPortOption>
128 boost::system::error_code get_option(const implementation_type& impl,
129 GettableSerialPortOption& option, boost::system::error_code& ec) const
131 return do_get_option(impl,
132 &win_iocp_serial_port_service::load_option<GettableSerialPortOption>,
136 // Send a break sequence to the serial port.
137 boost::system::error_code send_break(implementation_type&,
138 boost::system::error_code& ec)
140 ec = boost::asio::error::operation_not_supported;
144 // Write the given data. Returns the number of bytes sent.
145 template <typename ConstBufferSequence>
146 size_t write_some(implementation_type& impl,
147 const ConstBufferSequence& buffers, boost::system::error_code& ec)
149 return handle_service_.write_some(impl, buffers, ec);
152 // Start an asynchronous write. The data being written must be valid for the
153 // lifetime of the asynchronous operation.
154 template <typename ConstBufferSequence, typename Handler, typename IoExecutor>
155 void async_write_some(implementation_type& impl,
156 const ConstBufferSequence& buffers,
157 Handler& handler, const IoExecutor& io_ex)
159 handle_service_.async_write_some(impl, buffers, handler, io_ex);
162 // Read some data. Returns the number of bytes received.
163 template <typename MutableBufferSequence>
164 size_t read_some(implementation_type& impl,
165 const MutableBufferSequence& buffers, boost::system::error_code& ec)
167 return handle_service_.read_some(impl, buffers, ec);
170 // Start an asynchronous read. The buffer for the data being received must be
171 // valid for the lifetime of the asynchronous operation.
172 template <typename MutableBufferSequence,
173 typename Handler, typename IoExecutor>
174 void async_read_some(implementation_type& impl,
175 const MutableBufferSequence& buffers,
176 Handler& handler, const IoExecutor& io_ex)
178 handle_service_.async_read_some(impl, buffers, handler, io_ex);
182 // Function pointer type for storing a serial port option.
183 typedef boost::system::error_code (*store_function_type)(
184 const void*, ::DCB&, boost::system::error_code&);
186 // Helper function template to store a serial port option.
187 template <typename SettableSerialPortOption>
188 static boost::system::error_code store_option(const void* option,
189 ::DCB& storage, boost::system::error_code& ec)
191 static_cast<const SettableSerialPortOption*>(option)->store(storage, ec);
195 // Helper function to set a serial port option.
196 BOOST_ASIO_DECL boost::system::error_code do_set_option(
197 implementation_type& impl, store_function_type store,
198 const void* option, boost::system::error_code& ec);
200 // Function pointer type for loading a serial port option.
201 typedef boost::system::error_code (*load_function_type)(
202 void*, const ::DCB&, boost::system::error_code&);
204 // Helper function template to load a serial port option.
205 template <typename GettableSerialPortOption>
206 static boost::system::error_code load_option(void* option,
207 const ::DCB& storage, boost::system::error_code& ec)
209 static_cast<GettableSerialPortOption*>(option)->load(storage, ec);
213 // Helper function to get a serial port option.
214 BOOST_ASIO_DECL boost::system::error_code do_get_option(
215 const implementation_type& impl, load_function_type load,
216 void* option, boost::system::error_code& ec) const;
218 // The implementation used for initiating asynchronous operations.
219 win_iocp_handle_service handle_service_;
222 } // namespace detail
226 #include <boost/asio/detail/pop_options.hpp>
228 #if defined(BOOST_ASIO_HEADER_ONLY)
229 # include <boost/asio/detail/impl/win_iocp_serial_port_service.ipp>
230 #endif // defined(BOOST_ASIO_HEADER_ONLY)
232 #endif // defined(BOOST_ASIO_HAS_IOCP) && defined(BOOST_ASIO_HAS_SERIAL_PORT)
234 #endif // BOOST_ASIO_DETAIL_WIN_IOCP_SERIAL_PORT_SERVICE_HPP