// | |
// posix/descriptor_base.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_POSIX_DESCRIPTOR_BASE_HPP | |
#define BOOST_ASIO_POSIX_DESCRIPTOR_BASE_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_POSIX_STREAM_DESCRIPTOR) \ | |
|| defined(GENERATING_DOCUMENTATION) | |
#include <boost/asio/detail/io_control.hpp> | |
#include <boost/asio/detail/socket_option.hpp> | |
#include <boost/asio/detail/push_options.hpp> | |
namespace boost { | |
namespace asio { | |
namespace posix { | |
/// The descriptor_base class is used as a base for the basic_stream_descriptor | |
/// class template so that we have a common place to define the associated | |
/// IO control commands. | |
class descriptor_base | |
{ | |
public: | |
/// IO control command to set the blocking mode of the descriptor. | |
/** | |
* Implements the FIONBIO IO control command. | |
* | |
* @par Example | |
* @code | |
* boost::asio::posix::stream_descriptor descriptor(io_service); | |
* ... | |
* boost::asio::descriptor_base::non_blocking_io command(true); | |
* descriptor.io_control(command); | |
* @endcode | |
* | |
* @par Concepts: | |
* IoControlCommand. | |
*/ | |
#if defined(GENERATING_DOCUMENTATION) | |
typedef implementation_defined non_blocking_io; | |
#else | |
typedef boost::asio::detail::io_control::non_blocking_io non_blocking_io; | |
#endif | |
/// IO control command to get the amount of data that can be read without | |
/// blocking. | |
/** | |
* Implements the FIONREAD IO control command. | |
* | |
* @par Example | |
* @code | |
* boost::asio::posix::stream_descriptor descriptor(io_service); | |
* ... | |
* boost::asio::descriptor_base::bytes_readable command(true); | |
* descriptor.io_control(command); | |
* std::size_t bytes_readable = command.get(); | |
* @endcode | |
* | |
* @par Concepts: | |
* IoControlCommand. | |
*/ | |
#if defined(GENERATING_DOCUMENTATION) | |
typedef implementation_defined bytes_readable; | |
#else | |
typedef boost::asio::detail::io_control::bytes_readable bytes_readable; | |
#endif | |
protected: | |
/// Protected destructor to prevent deletion through this type. | |
~descriptor_base() | |
{ | |
} | |
}; | |
} // namespace posix | |
} // namespace asio | |
} // namespace boost | |
#include <boost/asio/detail/pop_options.hpp> | |
#endif // defined(BOOST_ASIO_HAS_POSIX_STREAM_DESCRIPTOR) | |
// || defined(GENERATING_DOCUMENTATION) | |
#endif // BOOST_ASIO_POSIX_DESCRIPTOR_BASE_HPP |