basic_serial_port.hpp

Go to the documentation of this file.

//
// basic_serial_port.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2003-2008 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 ASIO_BASIC_SERIAL_PORT_HPP
#define ASIO_BASIC_SERIAL_PORT_HPP

#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)

#include "asio/detail/push_options.hpp"

#include "asio/detail/push_options.hpp"
#include <string>
#include <boost/config.hpp>
#include "asio/detail/pop_options.hpp"

#include "asio/basic_io_object.hpp"
#include "asio/error.hpp"
#include "asio/serial_port_base.hpp"
#include "asio/serial_port_service.hpp"
#include "asio/detail/throw_error.hpp"

#if defined(ASIO_HAS_SERIAL_PORT) \
  || defined(GENERATING_DOCUMENTATION)

namespace asio {


template <typename SerialPortService = serial_port_service>
class basic_serial_port
  : public basic_io_object<SerialPortService>,
    public serial_port_base
{
public:
  typedef typename SerialPortService::native_type native_type;

  typedef basic_serial_port<SerialPortService> lowest_layer_type;


  explicit basic_serial_port(asio::io_service& io_service)
    : basic_io_object<SerialPortService>(io_service)
  {
  }


  explicit basic_serial_port(asio::io_service& io_service,
      const char* device)
    : basic_io_object<SerialPortService>(io_service)
  {
    asio::error_code ec;
    this->service.open(this->implementation, device, ec);
    asio::detail::throw_error(ec);
  }


  explicit basic_serial_port(asio::io_service& io_service,
      const std::string& device)
    : basic_io_object<SerialPortService>(io_service)
  {
    asio::error_code ec;
    this->service.open(this->implementation, device, ec);
    asio::detail::throw_error(ec);
  }


  basic_serial_port(asio::io_service& io_service,
      const native_type& native_serial_port)
    : basic_io_object<SerialPortService>(io_service)
  {
    asio::error_code ec;
    this->service.assign(this->implementation, native_serial_port, ec);
    asio::detail::throw_error(ec);
  }


  lowest_layer_type& lowest_layer()
  {
    return *this;
  }


  void open(const std::string& device)
  {
    asio::error_code ec;
    this->service.open(this->implementation, device, ec);
    asio::detail::throw_error(ec);
  }


  asio::error_code open(const std::string& device,
      asio::error_code& ec)
  {
    return this->service.open(this->implementation, device, ec);
  }

  /*
   * This function opens the serial port to hold an existing native serial port.
   *
   * @param native_serial_port A native serial port.
   *
   * @throws asio::system_error Thrown on failure.
   */
  void assign(const native_type& native_serial_port)
  {
    asio::error_code ec;
    this->service.assign(this->implementation, native_serial_port, ec);
    asio::detail::throw_error(ec);
  }

  /*
   * This function opens the serial port to hold an existing native serial port.
   *
   * @param native_serial_port A native serial port.
   *
   * @param ec Set to indicate what error occurred, if any.
   */
  asio::error_code assign(const native_type& native_serial_port,
      asio::error_code& ec)
  {
    return this->service.assign(this->implementation, native_serial_port, ec);
  }

  bool is_open() const
  {
    return this->service.is_open(this->implementation);
  }


  void close()
  {
    asio::error_code ec;
    this->service.close(this->implementation, ec);
    asio::detail::throw_error(ec);
  }


  asio::error_code close(asio::error_code& ec)
  {
    return this->service.close(this->implementation, ec);
  }


  native_type native()
  {
    return this->service.native(this->implementation);
  }


  void cancel()
  {
    asio::error_code ec;
    this->service.cancel(this->implementation, ec);
    asio::detail::throw_error(ec);
  }


  asio::error_code cancel(asio::error_code& ec)
  {
    return this->service.cancel(this->implementation, ec);
  }


  void send_break()
  {
    asio::error_code ec;
    this->service.send_break(this->implementation, ec);
    asio::detail::throw_error(ec);
  }


  asio::error_code send_break(asio::error_code& ec)
  {
    return this->service.send_break(this->implementation, ec);
  }


  template <typename SettableSerialPortOption>
  void set_option(const SettableSerialPortOption& option)
  {
    asio::error_code ec;
    this->service.set_option(this->implementation, option, ec);
    asio::detail::throw_error(ec);
  }


  template <typename SettableSerialPortOption>
  asio::error_code set_option(const SettableSerialPortOption& option,
      asio::error_code& ec)
  {
    return this->service.set_option(this->implementation, option, ec);
  }


  template <typename GettableSerialPortOption>
  void get_option(GettableSerialPortOption& option)
  {
    asio::error_code ec;
    this->service.get_option(this->implementation, option, ec);
    asio::detail::throw_error(ec);
  }


  template <typename GettableSerialPortOption>
  asio::error_code get_option(GettableSerialPortOption& option,
      asio::error_code& ec)
  {
    return this->service.get_option(this->implementation, option, ec);
  }


  template <typename ConstBufferSequence>
  std::size_t write_some(const ConstBufferSequence& buffers)
  {
    asio::error_code ec;
    std::size_t s = this->service.write_some(this->implementation, buffers, ec);
    asio::detail::throw_error(ec);
    return s;
  }


  template <typename ConstBufferSequence>
  std::size_t write_some(const ConstBufferSequence& buffers,
      asio::error_code& ec)
  {
    return this->service.write_some(this->implementation, buffers, ec);
  }


  template <typename ConstBufferSequence, typename WriteHandler>
  void async_write_some(const ConstBufferSequence& buffers,
      WriteHandler handler)
  {
    this->service.async_write_some(this->implementation, buffers, handler);
  }


  template <typename MutableBufferSequence>
  std::size_t read_some(const MutableBufferSequence& buffers)
  {
    asio::error_code ec;
    std::size_t s = this->service.read_some(this->implementation, buffers, ec);
    asio::detail::throw_error(ec);
    return s;
  }


  template <typename MutableBufferSequence>
  std::size_t read_some(const MutableBufferSequence& buffers,
      asio::error_code& ec)
  {
    return this->service.read_some(this->implementation, buffers, ec);
  }


  template <typename MutableBufferSequence, typename ReadHandler>
  void async_read_some(const MutableBufferSequence& buffers,
      ReadHandler handler)
  {
    this->service.async_read_some(this->implementation, buffers, handler);
  }
};

} // namespace asio

#endif // defined(ASIO_HAS_SERIAL_PORT)
       //   || defined(GENERATING_DOCUMENTATION)

#include "asio/detail/pop_options.hpp"

#endif // ASIO_BASIC_SERIAL_PORT_HPP