basic_descriptor.hpp

Go to the documentation of this file.

//
// basic_descriptor.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2003-2008 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 ASIO_POSIX_BASIC_DESCRIPTOR_HPP
#define ASIO_POSIX_BASIC_DESCRIPTOR_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 <boost/config.hpp>
#include "asio/detail/pop_options.hpp"

#include "asio/basic_io_object.hpp"
#include "asio/error.hpp"
#include "asio/posix/descriptor_base.hpp"
#include "asio/detail/throw_error.hpp"

namespace asio {
namespace posix {


template <typename DescriptorService>
class basic_descriptor
  : public basic_io_object<DescriptorService>,
    public descriptor_base
{
public:
  typedef typename DescriptorService::native_type native_type;

  typedef basic_descriptor<DescriptorService> lowest_layer_type;


  explicit basic_descriptor(asio::io_service& io_service)
    : basic_io_object<DescriptorService>(io_service)
  {
  }


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


  lowest_layer_type& lowest_layer()
  {
    return *this;
  }

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

  /*
   * This function opens the descriptor to hold an existing native descriptor.
   *
   * @param native_descriptor A native descriptor.
   *
   * @param ec Set to indicate what error occurred, if any.
   */
  asio::error_code assign(const native_type& native_descriptor,
      asio::error_code& ec)
  {
    return this->service.assign(this->implementation, native_descriptor, 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);
  }


  template <typename IoControlCommand>
  void io_control(IoControlCommand& command)
  {
    asio::error_code ec;
    this->service.io_control(this->implementation, command, ec);
    asio::detail::throw_error(ec);
  }


  template <typename IoControlCommand>
  asio::error_code io_control(IoControlCommand& command,
      asio::error_code& ec)
  {
    return this->service.io_control(this->implementation, command, ec);
  }

protected:
  ~basic_descriptor()
  {
  }
};

} // namespace posix
} // namespace asio

#include "asio/detail/pop_options.hpp"

#endif // ASIO_POSIX_BASIC_DESCRIPTOR_HPP