// | |
// serial_port_service.hpp | |
// ~~~~~~~~~~~~~~~~~~~~~~~ | |
// | |
// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot 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_SERIAL_PORT_SERVICE_HPP | |
#define BOOST_ASIO_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_SERIAL_PORT) \ | |
|| defined(GENERATING_DOCUMENTATION) | |
#include <cstddef> | |
#include <string> | |
#include <boost/asio/detail/reactive_serial_port_service.hpp> | |
#include <boost/asio/detail/win_iocp_serial_port_service.hpp> | |
#include <boost/asio/error.hpp> | |
#include <boost/asio/io_service.hpp> | |
#include <boost/asio/serial_port_base.hpp> | |
#include <boost/asio/detail/push_options.hpp> | |
namespace boost { | |
namespace asio { | |
/// Default service implementation for a serial port. | |
class serial_port_service | |
#if defined(GENERATING_DOCUMENTATION) | |
: public boost::asio::io_service::service | |
#else | |
: public boost::asio::detail::service_base<serial_port_service> | |
#endif | |
{ | |
public: | |
#if defined(GENERATING_DOCUMENTATION) | |
/// The unique service identifier. | |
static boost::asio::io_service::id id; | |
#endif | |
private: | |
// The type of the platform-specific implementation. | |
#if defined(BOOST_ASIO_HAS_IOCP) | |
typedef detail::win_iocp_serial_port_service service_impl_type; | |
#else | |
typedef detail::reactive_serial_port_service service_impl_type; | |
#endif | |
public: | |
/// The type of a serial port implementation. | |
#if defined(GENERATING_DOCUMENTATION) | |
typedef implementation_defined implementation_type; | |
#else | |
typedef service_impl_type::implementation_type implementation_type; | |
#endif | |
/// The native handle type. | |
#if defined(GENERATING_DOCUMENTATION) | |
typedef implementation_defined native_type; | |
#else | |
typedef service_impl_type::native_type native_type; | |
#endif | |
/// Construct a new serial port service for the specified io_service. | |
explicit serial_port_service(boost::asio::io_service& io_service) | |
: boost::asio::detail::service_base<serial_port_service>(io_service), | |
service_impl_(io_service) | |
{ | |
} | |
/// Destroy all user-defined handler objects owned by the service. | |
void shutdown_service() | |
{ | |
service_impl_.shutdown_service(); | |
} | |
/// Construct a new serial port implementation. | |
void construct(implementation_type& impl) | |
{ | |
service_impl_.construct(impl); | |
} | |
/// Destroy a serial port implementation. | |
void destroy(implementation_type& impl) | |
{ | |
service_impl_.destroy(impl); | |
} | |
/// Open a serial port. | |
boost::system::error_code open(implementation_type& impl, | |
const std::string& device, boost::system::error_code& ec) | |
{ | |
return service_impl_.open(impl, device, ec); | |
} | |
/// Assign an existing native handle to a serial port. | |
boost::system::error_code assign(implementation_type& impl, | |
const native_type& native_handle, boost::system::error_code& ec) | |
{ | |
return service_impl_.assign(impl, native_handle, ec); | |
} | |
/// Determine whether the handle is open. | |
bool is_open(const implementation_type& impl) const | |
{ | |
return service_impl_.is_open(impl); | |
} | |
/// Close a serial port implementation. | |
boost::system::error_code close(implementation_type& impl, | |
boost::system::error_code& ec) | |
{ | |
return service_impl_.close(impl, ec); | |
} | |
/// Get the native handle implementation. | |
native_type native(implementation_type& impl) | |
{ | |
return service_impl_.native(impl); | |
} | |
/// Cancel all asynchronous operations associated with the handle. | |
boost::system::error_code cancel(implementation_type& impl, | |
boost::system::error_code& ec) | |
{ | |
return service_impl_.cancel(impl, ec); | |
} | |
/// Set a serial port option. | |
template <typename SettableSerialPortOption> | |
boost::system::error_code set_option(implementation_type& impl, | |
const SettableSerialPortOption& option, boost::system::error_code& ec) | |
{ | |
return service_impl_.set_option(impl, option, ec); | |
} | |
/// Get a serial port option. | |
template <typename GettableSerialPortOption> | |
boost::system::error_code get_option(const implementation_type& impl, | |
GettableSerialPortOption& option, boost::system::error_code& ec) const | |
{ | |
return service_impl_.get_option(impl, option, ec); | |
} | |
/// Send a break sequence to the serial port. | |
boost::system::error_code send_break(implementation_type& impl, | |
boost::system::error_code& ec) | |
{ | |
return service_impl_.send_break(impl, ec); | |
} | |
/// Write the given data to the stream. | |
template <typename ConstBufferSequence> | |
std::size_t write_some(implementation_type& impl, | |
const ConstBufferSequence& buffers, boost::system::error_code& ec) | |
{ | |
return service_impl_.write_some(impl, buffers, ec); | |
} | |
/// Start an asynchronous write. | |
template <typename ConstBufferSequence, typename WriteHandler> | |
void async_write_some(implementation_type& impl, | |
const ConstBufferSequence& buffers, WriteHandler handler) | |
{ | |
service_impl_.async_write_some(impl, buffers, handler); | |
} | |
/// Read some data from the stream. | |
template <typename MutableBufferSequence> | |
std::size_t read_some(implementation_type& impl, | |
const MutableBufferSequence& buffers, boost::system::error_code& ec) | |
{ | |
return service_impl_.read_some(impl, buffers, ec); | |
} | |
/// Start an asynchronous read. | |
template <typename MutableBufferSequence, typename ReadHandler> | |
void async_read_some(implementation_type& impl, | |
const MutableBufferSequence& buffers, ReadHandler handler) | |
{ | |
service_impl_.async_read_some(impl, buffers, handler); | |
} | |
private: | |
// The platform-specific implementation. | |
service_impl_type service_impl_; | |
}; | |
} // namespace asio | |
} // namespace boost | |
#include <boost/asio/detail/pop_options.hpp> | |
#endif // defined(BOOST_ASIO_HAS_SERIAL_PORT) | |
// || defined(GENERATING_DOCUMENTATION) | |
#endif // BOOST_ASIO_SERIAL_PORT_SERVICE_HPP |