// | |
// detail/win_iocp_serial_port_service.hpp | |
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
// | |
// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com) | |
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info@repinvariant.com) | |
// | |
// Distributed under the Boost Software License, Version 1.0. (See accompanying | |
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) | |
// | |
#ifndef BOOST_ASIO_DETAIL_WIN_IOCP_SERIAL_PORT_SERVICE_HPP | |
#define BOOST_ASIO_DETAIL_WIN_IOCP_SERIAL_PORT_SERVICE_HPP | |
#if defined(_MSC_VER) && (_MSC_VER >= 1200) | |
# pragma once | |
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) | |
#include <boost/asio/detail/config.hpp> | |
#if defined(BOOST_ASIO_HAS_IOCP) && defined(BOOST_ASIO_HAS_SERIAL_PORT) | |
#include <string> | |
#include <boost/asio/error.hpp> | |
#include <boost/asio/io_service.hpp> | |
#include <boost/asio/detail/win_iocp_handle_service.hpp> | |
#include <boost/asio/detail/push_options.hpp> | |
namespace boost { | |
namespace asio { | |
namespace detail { | |
// Extend win_iocp_handle_service to provide serial port support. | |
class win_iocp_serial_port_service | |
{ | |
public: | |
// The native type of a serial port. | |
typedef win_iocp_handle_service::native_type native_type; | |
// The implementation type of the serial port. | |
typedef win_iocp_handle_service::implementation_type implementation_type; | |
// Constructor. | |
BOOST_ASIO_DECL win_iocp_serial_port_service( | |
boost::asio::io_service& io_service); | |
// Destroy all user-defined handler objects owned by the service. | |
BOOST_ASIO_DECL void shutdown_service(); | |
// Construct a new serial port implementation. | |
void construct(implementation_type& impl) | |
{ | |
handle_service_.construct(impl); | |
} | |
// Destroy a serial port implementation. | |
void destroy(implementation_type& impl) | |
{ | |
handle_service_.destroy(impl); | |
} | |
// Open the serial port using the specified device name. | |
BOOST_ASIO_DECL boost::system::error_code open(implementation_type& impl, | |
const std::string& device, boost::system::error_code& ec); | |
// Assign a native handle to a serial port implementation. | |
boost::system::error_code assign(implementation_type& impl, | |
const native_type& native_handle, boost::system::error_code& ec) | |
{ | |
return handle_service_.assign(impl, native_handle, ec); | |
} | |
// Determine whether the serial port is open. | |
bool is_open(const implementation_type& impl) const | |
{ | |
return handle_service_.is_open(impl); | |
} | |
// Destroy a serial port implementation. | |
boost::system::error_code close(implementation_type& impl, | |
boost::system::error_code& ec) | |
{ | |
return handle_service_.close(impl, ec); | |
} | |
// Get the native serial port representation. | |
native_type native(implementation_type& impl) | |
{ | |
return handle_service_.native(impl); | |
} | |
// Cancel all operations associated with the handle. | |
boost::system::error_code cancel(implementation_type& impl, | |
boost::system::error_code& ec) | |
{ | |
return handle_service_.cancel(impl, ec); | |
} | |
// Set an option on the serial port. | |
template <typename SettableSerialPortOption> | |
boost::system::error_code set_option(implementation_type& impl, | |
const SettableSerialPortOption& option, boost::system::error_code& ec) | |
{ | |
return do_set_option(impl, | |
&win_iocp_serial_port_service::store_option<SettableSerialPortOption>, | |
&option, ec); | |
} | |
// Get an option from the serial port. | |
template <typename GettableSerialPortOption> | |
boost::system::error_code get_option(const implementation_type& impl, | |
GettableSerialPortOption& option, boost::system::error_code& ec) const | |
{ | |
return do_get_option(impl, | |
&win_iocp_serial_port_service::load_option<GettableSerialPortOption>, | |
&option, ec); | |
} | |
// Send a break sequence to the serial port. | |
boost::system::error_code send_break(implementation_type&, | |
boost::system::error_code& ec) | |
{ | |
ec = boost::asio::error::operation_not_supported; | |
return ec; | |
} | |
// Write the given data. Returns the number of bytes sent. | |
template <typename ConstBufferSequence> | |
size_t write_some(implementation_type& impl, | |
const ConstBufferSequence& buffers, boost::system::error_code& ec) | |
{ | |
return handle_service_.write_some(impl, buffers, ec); | |
} | |
// Start an asynchronous write. The data being written must be valid for the | |
// lifetime of the asynchronous operation. | |
template <typename ConstBufferSequence, typename Handler> | |
void async_write_some(implementation_type& impl, | |
const ConstBufferSequence& buffers, Handler handler) | |
{ | |
handle_service_.async_write_some(impl, buffers, handler); | |
} | |
// Read some data. Returns the number of bytes received. | |
template <typename MutableBufferSequence> | |
size_t read_some(implementation_type& impl, | |
const MutableBufferSequence& buffers, boost::system::error_code& ec) | |
{ | |
return handle_service_.read_some(impl, buffers, ec); | |
} | |
// Start an asynchronous read. The buffer for the data being received must be | |
// valid for the lifetime of the asynchronous operation. | |
template <typename MutableBufferSequence, typename Handler> | |
void async_read_some(implementation_type& impl, | |
const MutableBufferSequence& buffers, Handler handler) | |
{ | |
handle_service_.async_read_some(impl, buffers, handler); | |
} | |
private: | |
// Function pointer type for storing a serial port option. | |
typedef boost::system::error_code (*store_function_type)( | |
const void*, ::DCB&, boost::system::error_code&); | |
// Helper function template to store a serial port option. | |
template <typename SettableSerialPortOption> | |
static boost::system::error_code store_option(const void* option, | |
::DCB& storage, boost::system::error_code& ec) | |
{ | |
return static_cast<const SettableSerialPortOption*>(option)->store( | |
storage, ec); | |
} | |
// Helper function to set a serial port option. | |
BOOST_ASIO_DECL boost::system::error_code do_set_option( | |
implementation_type& impl, store_function_type store, | |
const void* option, boost::system::error_code& ec); | |
// Function pointer type for loading a serial port option. | |
typedef boost::system::error_code (*load_function_type)( | |
void*, const ::DCB&, boost::system::error_code&); | |
// Helper function template to load a serial port option. | |
template <typename GettableSerialPortOption> | |
static boost::system::error_code load_option(void* option, | |
const ::DCB& storage, boost::system::error_code& ec) | |
{ | |
return static_cast<GettableSerialPortOption*>(option)->load(storage, ec); | |
} | |
// Helper function to get a serial port option. | |
BOOST_ASIO_DECL boost::system::error_code do_get_option( | |
const implementation_type& impl, load_function_type load, | |
void* option, boost::system::error_code& ec) const; | |
// The implementation used for initiating asynchronous operations. | |
win_iocp_handle_service handle_service_; | |
}; | |
} // namespace detail | |
} // namespace asio | |
} // namespace boost | |
#include <boost/asio/detail/pop_options.hpp> | |
#if defined(BOOST_ASIO_HEADER_ONLY) | |
# include <boost/asio/detail/impl/win_iocp_serial_port_service.ipp> | |
#endif // defined(BOOST_ASIO_HEADER_ONLY) | |
#endif // defined(BOOST_ASIO_HAS_IOCP) && defined(BOOST_ASIO_HAS_SERIAL_PORT) | |
#endif // BOOST_ASIO_DETAIL_WIN_IOCP_SERIAL_PORT_SERVICE_HPP |