Imported existing code
This commit is contained in:
296
libraries/include/boost/asio/posix/basic_descriptor.hpp
Normal file
296
libraries/include/boost/asio/posix/basic_descriptor.hpp
Normal file
@@ -0,0 +1,296 @@
|
||||
//
|
||||
// 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 BOOST_ASIO_POSIX_BASIC_DESCRIPTOR_HPP
|
||||
#define BOOST_ASIO_POSIX_BASIC_DESCRIPTOR_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include <boost/asio/detail/push_options.hpp>
|
||||
|
||||
#include <boost/asio/detail/push_options.hpp>
|
||||
#include <boost/config.hpp>
|
||||
#include <boost/asio/detail/pop_options.hpp>
|
||||
|
||||
#include <boost/asio/basic_io_object.hpp>
|
||||
#include <boost/asio/error.hpp>
|
||||
#include <boost/asio/posix/descriptor_base.hpp>
|
||||
#include <boost/asio/detail/throw_error.hpp>
|
||||
|
||||
namespace boost {
|
||||
namespace asio {
|
||||
namespace posix {
|
||||
|
||||
/// Provides POSIX descriptor functionality.
|
||||
/**
|
||||
* The posix::basic_descriptor class template provides the ability to wrap a
|
||||
* POSIX descriptor.
|
||||
*
|
||||
* @par Thread Safety
|
||||
* @e Distinct @e objects: Safe.@n
|
||||
* @e Shared @e objects: Unsafe.
|
||||
*/
|
||||
template <typename DescriptorService>
|
||||
class basic_descriptor
|
||||
: public basic_io_object<DescriptorService>,
|
||||
public descriptor_base
|
||||
{
|
||||
public:
|
||||
/// The native representation of a descriptor.
|
||||
typedef typename DescriptorService::native_type native_type;
|
||||
|
||||
/// A basic_descriptor is always the lowest layer.
|
||||
typedef basic_descriptor<DescriptorService> lowest_layer_type;
|
||||
|
||||
/// Construct a basic_descriptor without opening it.
|
||||
/**
|
||||
* This constructor creates a descriptor without opening it.
|
||||
*
|
||||
* @param io_service The io_service object that the descriptor will use to
|
||||
* dispatch handlers for any asynchronous operations performed on the
|
||||
* descriptor.
|
||||
*/
|
||||
explicit basic_descriptor(boost::asio::io_service& io_service)
|
||||
: basic_io_object<DescriptorService>(io_service)
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct a basic_descriptor on an existing native descriptor.
|
||||
/**
|
||||
* This constructor creates a descriptor object to hold an existing native
|
||||
* descriptor.
|
||||
*
|
||||
* @param io_service The io_service object that the descriptor will use to
|
||||
* dispatch handlers for any asynchronous operations performed on the
|
||||
* descriptor.
|
||||
*
|
||||
* @param native_descriptor A native descriptor.
|
||||
*
|
||||
* @throws boost::system::system_error Thrown on failure.
|
||||
*/
|
||||
basic_descriptor(boost::asio::io_service& io_service,
|
||||
const native_type& native_descriptor)
|
||||
: basic_io_object<DescriptorService>(io_service)
|
||||
{
|
||||
boost::system::error_code ec;
|
||||
this->service.assign(this->implementation, native_descriptor, ec);
|
||||
boost::asio::detail::throw_error(ec);
|
||||
}
|
||||
|
||||
/// Get a reference to the lowest layer.
|
||||
/**
|
||||
* This function returns a reference to the lowest layer in a stack of
|
||||
* layers. Since a basic_descriptor cannot contain any further layers, it
|
||||
* simply returns a reference to itself.
|
||||
*
|
||||
* @return A reference to the lowest layer in the stack of layers. Ownership
|
||||
* is not transferred to the caller.
|
||||
*/
|
||||
lowest_layer_type& lowest_layer()
|
||||
{
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// Get a const reference to the lowest layer.
|
||||
/**
|
||||
* This function returns a const reference to the lowest layer in a stack of
|
||||
* layers. Since a basic_descriptor cannot contain any further layers, it
|
||||
* simply returns a reference to itself.
|
||||
*
|
||||
* @return A const reference to the lowest layer in the stack of layers.
|
||||
* Ownership is not transferred to the caller.
|
||||
*/
|
||||
const lowest_layer_type& lowest_layer() const
|
||||
{
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// Assign an existing native descriptor to the descriptor.
|
||||
/*
|
||||
* This function opens the descriptor to hold an existing native descriptor.
|
||||
*
|
||||
* @param native_descriptor A native descriptor.
|
||||
*
|
||||
* @throws boost::system::system_error Thrown on failure.
|
||||
*/
|
||||
void assign(const native_type& native_descriptor)
|
||||
{
|
||||
boost::system::error_code ec;
|
||||
this->service.assign(this->implementation, native_descriptor, ec);
|
||||
boost::asio::detail::throw_error(ec);
|
||||
}
|
||||
|
||||
/// Assign an existing native descriptor to the descriptor.
|
||||
/*
|
||||
* 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.
|
||||
*/
|
||||
boost::system::error_code assign(const native_type& native_descriptor,
|
||||
boost::system::error_code& ec)
|
||||
{
|
||||
return this->service.assign(this->implementation, native_descriptor, ec);
|
||||
}
|
||||
|
||||
/// Determine whether the descriptor is open.
|
||||
bool is_open() const
|
||||
{
|
||||
return this->service.is_open(this->implementation);
|
||||
}
|
||||
|
||||
/// Close the descriptor.
|
||||
/**
|
||||
* This function is used to close the descriptor. Any asynchronous read or
|
||||
* write operations will be cancelled immediately, and will complete with the
|
||||
* boost::asio::error::operation_aborted error.
|
||||
*
|
||||
* @throws boost::system::system_error Thrown on failure.
|
||||
*/
|
||||
void close()
|
||||
{
|
||||
boost::system::error_code ec;
|
||||
this->service.close(this->implementation, ec);
|
||||
boost::asio::detail::throw_error(ec);
|
||||
}
|
||||
|
||||
/// Close the descriptor.
|
||||
/**
|
||||
* This function is used to close the descriptor. Any asynchronous read or
|
||||
* write operations will be cancelled immediately, and will complete with the
|
||||
* boost::asio::error::operation_aborted error.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*/
|
||||
boost::system::error_code close(boost::system::error_code& ec)
|
||||
{
|
||||
return this->service.close(this->implementation, ec);
|
||||
}
|
||||
|
||||
/// Get the native descriptor representation.
|
||||
/**
|
||||
* This function may be used to obtain the underlying representation of the
|
||||
* descriptor. This is intended to allow access to native descriptor
|
||||
* functionality that is not otherwise provided.
|
||||
*/
|
||||
native_type native()
|
||||
{
|
||||
return this->service.native(this->implementation);
|
||||
}
|
||||
|
||||
/// Cancel all asynchronous operations associated with the descriptor.
|
||||
/**
|
||||
* This function causes all outstanding asynchronous read or write operations
|
||||
* to finish immediately, and the handlers for cancelled operations will be
|
||||
* passed the boost::asio::error::operation_aborted error.
|
||||
*
|
||||
* @throws boost::system::system_error Thrown on failure.
|
||||
*/
|
||||
void cancel()
|
||||
{
|
||||
boost::system::error_code ec;
|
||||
this->service.cancel(this->implementation, ec);
|
||||
boost::asio::detail::throw_error(ec);
|
||||
}
|
||||
|
||||
/// Cancel all asynchronous operations associated with the descriptor.
|
||||
/**
|
||||
* This function causes all outstanding asynchronous read or write operations
|
||||
* to finish immediately, and the handlers for cancelled operations will be
|
||||
* passed the boost::asio::error::operation_aborted error.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*/
|
||||
boost::system::error_code cancel(boost::system::error_code& ec)
|
||||
{
|
||||
return this->service.cancel(this->implementation, ec);
|
||||
}
|
||||
|
||||
/// Perform an IO control command on the descriptor.
|
||||
/**
|
||||
* This function is used to execute an IO control command on the descriptor.
|
||||
*
|
||||
* @param command The IO control command to be performed on the descriptor.
|
||||
*
|
||||
* @throws boost::system::system_error Thrown on failure.
|
||||
*
|
||||
* @sa IoControlCommand @n
|
||||
* boost::asio::posix::descriptor_base::bytes_readable @n
|
||||
* boost::asio::posix::descriptor_base::non_blocking_io
|
||||
*
|
||||
* @par Example
|
||||
* Getting the number of bytes ready to read:
|
||||
* @code
|
||||
* boost::asio::posix::stream_descriptor descriptor(io_service);
|
||||
* ...
|
||||
* boost::asio::posix::stream_descriptor::bytes_readable command;
|
||||
* descriptor.io_control(command);
|
||||
* std::size_t bytes_readable = command.get();
|
||||
* @endcode
|
||||
*/
|
||||
template <typename IoControlCommand>
|
||||
void io_control(IoControlCommand& command)
|
||||
{
|
||||
boost::system::error_code ec;
|
||||
this->service.io_control(this->implementation, command, ec);
|
||||
boost::asio::detail::throw_error(ec);
|
||||
}
|
||||
|
||||
/// Perform an IO control command on the descriptor.
|
||||
/**
|
||||
* This function is used to execute an IO control command on the descriptor.
|
||||
*
|
||||
* @param command The IO control command to be performed on the descriptor.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*
|
||||
* @sa IoControlCommand @n
|
||||
* boost::asio::posix::descriptor_base::bytes_readable @n
|
||||
* boost::asio::posix::descriptor_base::non_blocking_io
|
||||
*
|
||||
* @par Example
|
||||
* Getting the number of bytes ready to read:
|
||||
* @code
|
||||
* boost::asio::posix::stream_descriptor descriptor(io_service);
|
||||
* ...
|
||||
* boost::asio::posix::stream_descriptor::bytes_readable command;
|
||||
* boost::system::error_code ec;
|
||||
* descriptor.io_control(command, ec);
|
||||
* if (ec)
|
||||
* {
|
||||
* // An error occurred.
|
||||
* }
|
||||
* std::size_t bytes_readable = command.get();
|
||||
* @endcode
|
||||
*/
|
||||
template <typename IoControlCommand>
|
||||
boost::system::error_code io_control(IoControlCommand& command,
|
||||
boost::system::error_code& ec)
|
||||
{
|
||||
return this->service.io_control(this->implementation, command, ec);
|
||||
}
|
||||
|
||||
protected:
|
||||
/// Protected destructor to prevent deletion through this type.
|
||||
~basic_descriptor()
|
||||
{
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace posix
|
||||
} // namespace asio
|
||||
} // namespace boost
|
||||
|
||||
#include <boost/asio/detail/pop_options.hpp>
|
||||
|
||||
#endif // BOOST_ASIO_POSIX_BASIC_DESCRIPTOR_HPP
|
||||
306
libraries/include/boost/asio/posix/basic_stream_descriptor.hpp
Normal file
306
libraries/include/boost/asio/posix/basic_stream_descriptor.hpp
Normal file
@@ -0,0 +1,306 @@
|
||||
//
|
||||
// basic_stream_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 BOOST_ASIO_POSIX_BASIC_STREAM_DESCRIPTOR_HPP
|
||||
#define BOOST_ASIO_POSIX_BASIC_STREAM_DESCRIPTOR_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include <boost/asio/detail/push_options.hpp>
|
||||
|
||||
#include <boost/asio/detail/push_options.hpp>
|
||||
#include <cstddef>
|
||||
#include <boost/config.hpp>
|
||||
#include <boost/asio/detail/pop_options.hpp>
|
||||
|
||||
#include <boost/asio/error.hpp>
|
||||
#include <boost/asio/posix/basic_descriptor.hpp>
|
||||
#include <boost/asio/posix/stream_descriptor_service.hpp>
|
||||
#include <boost/asio/detail/throw_error.hpp>
|
||||
|
||||
#if defined(BOOST_ASIO_HAS_POSIX_STREAM_DESCRIPTOR) \
|
||||
|| defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
namespace boost {
|
||||
namespace asio {
|
||||
namespace posix {
|
||||
|
||||
/// Provides stream-oriented descriptor functionality.
|
||||
/**
|
||||
* The posix::basic_stream_descriptor class template provides asynchronous and
|
||||
* blocking stream-oriented descriptor functionality.
|
||||
*
|
||||
* @par Thread Safety
|
||||
* @e Distinct @e objects: Safe.@n
|
||||
* @e Shared @e objects: Unsafe.
|
||||
*
|
||||
* @par Concepts:
|
||||
* AsyncReadStream, AsyncWriteStream, Stream, SyncReadStream, SyncWriteStream.
|
||||
*/
|
||||
template <typename StreamDescriptorService = stream_descriptor_service>
|
||||
class basic_stream_descriptor
|
||||
: public basic_descriptor<StreamDescriptorService>
|
||||
{
|
||||
public:
|
||||
/// The native representation of a descriptor.
|
||||
typedef typename StreamDescriptorService::native_type native_type;
|
||||
|
||||
/// Construct a basic_stream_descriptor without opening it.
|
||||
/**
|
||||
* This constructor creates a stream descriptor without opening it. The
|
||||
* descriptor needs to be opened and then connected or accepted before data
|
||||
* can be sent or received on it.
|
||||
*
|
||||
* @param io_service The io_service object that the stream descriptor will
|
||||
* use to dispatch handlers for any asynchronous operations performed on the
|
||||
* descriptor.
|
||||
*/
|
||||
explicit basic_stream_descriptor(boost::asio::io_service& io_service)
|
||||
: basic_descriptor<StreamDescriptorService>(io_service)
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct a basic_stream_descriptor on an existing native descriptor.
|
||||
/**
|
||||
* This constructor creates a stream descriptor object to hold an existing
|
||||
* native descriptor.
|
||||
*
|
||||
* @param io_service The io_service object that the stream descriptor will
|
||||
* use to dispatch handlers for any asynchronous operations performed on the
|
||||
* descriptor.
|
||||
*
|
||||
* @param native_descriptor The new underlying descriptor implementation.
|
||||
*
|
||||
* @throws boost::system::system_error Thrown on failure.
|
||||
*/
|
||||
basic_stream_descriptor(boost::asio::io_service& io_service,
|
||||
const native_type& native_descriptor)
|
||||
: basic_descriptor<StreamDescriptorService>(io_service, native_descriptor)
|
||||
{
|
||||
}
|
||||
|
||||
/// Write some data to the descriptor.
|
||||
/**
|
||||
* This function is used to write data to the stream descriptor. The function
|
||||
* call will block until one or more bytes of the data has been written
|
||||
* successfully, or until an error occurs.
|
||||
*
|
||||
* @param buffers One or more data buffers to be written to the descriptor.
|
||||
*
|
||||
* @returns The number of bytes written.
|
||||
*
|
||||
* @throws boost::system::system_error Thrown on failure. An error code of
|
||||
* boost::asio::error::eof indicates that the connection was closed by the
|
||||
* peer.
|
||||
*
|
||||
* @note The write_some operation may not transmit all of the data to the
|
||||
* peer. Consider using the @ref write function if you need to ensure that
|
||||
* all data is written before the blocking operation completes.
|
||||
*
|
||||
* @par Example
|
||||
* To write a single data buffer use the @ref buffer function as follows:
|
||||
* @code
|
||||
* descriptor.write_some(boost::asio::buffer(data, size));
|
||||
* @endcode
|
||||
* See the @ref buffer documentation for information on writing multiple
|
||||
* buffers in one go, and how to use it with arrays, boost::array or
|
||||
* std::vector.
|
||||
*/
|
||||
template <typename ConstBufferSequence>
|
||||
std::size_t write_some(const ConstBufferSequence& buffers)
|
||||
{
|
||||
boost::system::error_code ec;
|
||||
std::size_t s = this->service.write_some(this->implementation, buffers, ec);
|
||||
boost::asio::detail::throw_error(ec);
|
||||
return s;
|
||||
}
|
||||
|
||||
/// Write some data to the descriptor.
|
||||
/**
|
||||
* This function is used to write data to the stream descriptor. The function
|
||||
* call will block until one or more bytes of the data has been written
|
||||
* successfully, or until an error occurs.
|
||||
*
|
||||
* @param buffers One or more data buffers to be written to the descriptor.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*
|
||||
* @returns The number of bytes written. Returns 0 if an error occurred.
|
||||
*
|
||||
* @note The write_some operation may not transmit all of the data to the
|
||||
* peer. Consider using the @ref write function if you need to ensure that
|
||||
* all data is written before the blocking operation completes.
|
||||
*/
|
||||
template <typename ConstBufferSequence>
|
||||
std::size_t write_some(const ConstBufferSequence& buffers,
|
||||
boost::system::error_code& ec)
|
||||
{
|
||||
return this->service.write_some(this->implementation, buffers, ec);
|
||||
}
|
||||
|
||||
/// Start an asynchronous write.
|
||||
/**
|
||||
* This function is used to asynchronously write data to the stream
|
||||
* descriptor. The function call always returns immediately.
|
||||
*
|
||||
* @param buffers One or more data buffers to be written to the descriptor.
|
||||
* Although the buffers object may be copied as necessary, ownership of the
|
||||
* underlying memory blocks is retained by the caller, which must guarantee
|
||||
* that they remain valid until the handler is called.
|
||||
*
|
||||
* @param handler The handler to be called when the write operation completes.
|
||||
* Copies will be made of the handler as required. The function signature of
|
||||
* the handler must be:
|
||||
* @code void handler(
|
||||
* const boost::system::error_code& error, // Result of operation.
|
||||
* std::size_t bytes_transferred // Number of bytes written.
|
||||
* ); @endcode
|
||||
* Regardless of whether the asynchronous operation completes immediately or
|
||||
* not, the handler will not be invoked from within this function. Invocation
|
||||
* of the handler will be performed in a manner equivalent to using
|
||||
* boost::asio::io_service::post().
|
||||
*
|
||||
* @note The write operation may not transmit all of the data to the peer.
|
||||
* Consider using the @ref async_write function if you need to ensure that all
|
||||
* data is written before the asynchronous operation completes.
|
||||
*
|
||||
* @par Example
|
||||
* To write a single data buffer use the @ref buffer function as follows:
|
||||
* @code
|
||||
* descriptor.async_write_some(boost::asio::buffer(data, size), handler);
|
||||
* @endcode
|
||||
* See the @ref buffer documentation for information on writing multiple
|
||||
* buffers in one go, and how to use it with arrays, boost::array or
|
||||
* std::vector.
|
||||
*/
|
||||
template <typename ConstBufferSequence, typename WriteHandler>
|
||||
void async_write_some(const ConstBufferSequence& buffers,
|
||||
WriteHandler handler)
|
||||
{
|
||||
this->service.async_write_some(this->implementation, buffers, handler);
|
||||
}
|
||||
|
||||
/// Read some data from the descriptor.
|
||||
/**
|
||||
* This function is used to read data from the stream descriptor. The function
|
||||
* call will block until one or more bytes of data has been read successfully,
|
||||
* or until an error occurs.
|
||||
*
|
||||
* @param buffers One or more buffers into which the data will be read.
|
||||
*
|
||||
* @returns The number of bytes read.
|
||||
*
|
||||
* @throws boost::system::system_error Thrown on failure. An error code of
|
||||
* boost::asio::error::eof indicates that the connection was closed by the
|
||||
* peer.
|
||||
*
|
||||
* @note The read_some operation may not read all of the requested number of
|
||||
* bytes. Consider using the @ref read function if you need to ensure that
|
||||
* the requested amount of data is read before the blocking operation
|
||||
* completes.
|
||||
*
|
||||
* @par Example
|
||||
* To read into a single data buffer use the @ref buffer function as follows:
|
||||
* @code
|
||||
* descriptor.read_some(boost::asio::buffer(data, size));
|
||||
* @endcode
|
||||
* See the @ref buffer documentation for information on reading into multiple
|
||||
* buffers in one go, and how to use it with arrays, boost::array or
|
||||
* std::vector.
|
||||
*/
|
||||
template <typename MutableBufferSequence>
|
||||
std::size_t read_some(const MutableBufferSequence& buffers)
|
||||
{
|
||||
boost::system::error_code ec;
|
||||
std::size_t s = this->service.read_some(this->implementation, buffers, ec);
|
||||
boost::asio::detail::throw_error(ec);
|
||||
return s;
|
||||
}
|
||||
|
||||
/// Read some data from the descriptor.
|
||||
/**
|
||||
* This function is used to read data from the stream descriptor. The function
|
||||
* call will block until one or more bytes of data has been read successfully,
|
||||
* or until an error occurs.
|
||||
*
|
||||
* @param buffers One or more buffers into which the data will be read.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*
|
||||
* @returns The number of bytes read. Returns 0 if an error occurred.
|
||||
*
|
||||
* @note The read_some operation may not read all of the requested number of
|
||||
* bytes. Consider using the @ref read function if you need to ensure that
|
||||
* the requested amount of data is read before the blocking operation
|
||||
* completes.
|
||||
*/
|
||||
template <typename MutableBufferSequence>
|
||||
std::size_t read_some(const MutableBufferSequence& buffers,
|
||||
boost::system::error_code& ec)
|
||||
{
|
||||
return this->service.read_some(this->implementation, buffers, ec);
|
||||
}
|
||||
|
||||
/// Start an asynchronous read.
|
||||
/**
|
||||
* This function is used to asynchronously read data from the stream
|
||||
* descriptor. The function call always returns immediately.
|
||||
*
|
||||
* @param buffers One or more buffers into which the data will be read.
|
||||
* Although the buffers object may be copied as necessary, ownership of the
|
||||
* underlying memory blocks is retained by the caller, which must guarantee
|
||||
* that they remain valid until the handler is called.
|
||||
*
|
||||
* @param handler The handler to be called when the read operation completes.
|
||||
* Copies will be made of the handler as required. The function signature of
|
||||
* the handler must be:
|
||||
* @code void handler(
|
||||
* const boost::system::error_code& error, // Result of operation.
|
||||
* std::size_t bytes_transferred // Number of bytes read.
|
||||
* ); @endcode
|
||||
* Regardless of whether the asynchronous operation completes immediately or
|
||||
* not, the handler will not be invoked from within this function. Invocation
|
||||
* of the handler will be performed in a manner equivalent to using
|
||||
* boost::asio::io_service::post().
|
||||
*
|
||||
* @note The read operation may not read all of the requested number of bytes.
|
||||
* Consider using the @ref async_read function if you need to ensure that the
|
||||
* requested amount of data is read before the asynchronous operation
|
||||
* completes.
|
||||
*
|
||||
* @par Example
|
||||
* To read into a single data buffer use the @ref buffer function as follows:
|
||||
* @code
|
||||
* descriptor.async_read_some(boost::asio::buffer(data, size), handler);
|
||||
* @endcode
|
||||
* See the @ref buffer documentation for information on reading into multiple
|
||||
* buffers in one go, and how to use it with arrays, boost::array or
|
||||
* std::vector.
|
||||
*/
|
||||
template <typename MutableBufferSequence, typename ReadHandler>
|
||||
void async_read_some(const MutableBufferSequence& buffers,
|
||||
ReadHandler handler)
|
||||
{
|
||||
this->service.async_read_some(this->implementation, buffers, handler);
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace posix
|
||||
} // namespace asio
|
||||
} // namespace boost
|
||||
|
||||
#endif // defined(BOOST_ASIO_HAS_POSIX_STREAM_DESCRIPTOR)
|
||||
// || defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#include <boost/asio/detail/pop_options.hpp>
|
||||
|
||||
#endif // BOOST_ASIO_POSIX_BASIC_STREAM_DESCRIPTOR_HPP
|
||||
95
libraries/include/boost/asio/posix/descriptor_base.hpp
Normal file
95
libraries/include/boost/asio/posix/descriptor_base.hpp
Normal file
@@ -0,0 +1,95 @@
|
||||
//
|
||||
// descriptor_base.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 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/push_options.hpp>
|
||||
|
||||
#include <boost/asio/detail/push_options.hpp>
|
||||
#include <boost/config.hpp>
|
||||
#include <boost/detail/workaround.hpp>
|
||||
#include <boost/asio/detail/pop_options.hpp>
|
||||
|
||||
#include <boost/asio/detail/io_control.hpp>
|
||||
#include <boost/asio/detail/socket_option.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 // BOOST_ASIO_POSIX_DESCRIPTOR_BASE_HPP
|
||||
41
libraries/include/boost/asio/posix/stream_descriptor.hpp
Normal file
41
libraries/include/boost/asio/posix/stream_descriptor.hpp
Normal file
@@ -0,0 +1,41 @@
|
||||
//
|
||||
// stream_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 BOOST_ASIO_POSIX_STREAM_DESCRIPTOR_HPP
|
||||
#define BOOST_ASIO_POSIX_STREAM_DESCRIPTOR_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include <boost/asio/detail/push_options.hpp>
|
||||
|
||||
#include <boost/asio/posix/basic_stream_descriptor.hpp>
|
||||
|
||||
#if defined(BOOST_ASIO_HAS_POSIX_STREAM_DESCRIPTOR) \
|
||||
|| defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
namespace boost {
|
||||
namespace asio {
|
||||
namespace posix {
|
||||
|
||||
/// Typedef for the typical usage of a stream-oriented descriptor.
|
||||
typedef basic_stream_descriptor<> stream_descriptor;
|
||||
|
||||
} // namespace posix
|
||||
} // namespace asio
|
||||
} // namespace boost
|
||||
|
||||
#endif // defined(BOOST_ASIO_HAS_POSIX_STREAM_DESCRIPTOR)
|
||||
// || defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#include <boost/asio/detail/pop_options.hpp>
|
||||
|
||||
#endif // BOOST_ASIO_POSIX_STREAM_DESCRIPTOR_HPP
|
||||
202
libraries/include/boost/asio/posix/stream_descriptor_service.hpp
Normal file
202
libraries/include/boost/asio/posix/stream_descriptor_service.hpp
Normal file
@@ -0,0 +1,202 @@
|
||||
//
|
||||
// stream_descriptor_service.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 BOOST_ASIO_POSIX_STREAM_DESCRIPTOR_SERVICE_HPP
|
||||
#define BOOST_ASIO_POSIX_STREAM_DESCRIPTOR_SERVICE_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include <boost/asio/detail/push_options.hpp>
|
||||
|
||||
#include <boost/asio/detail/push_options.hpp>
|
||||
#include <cstddef>
|
||||
#include <boost/config.hpp>
|
||||
#include <boost/asio/detail/pop_options.hpp>
|
||||
|
||||
#include <boost/asio/error.hpp>
|
||||
#include <boost/asio/io_service.hpp>
|
||||
#include <boost/asio/detail/epoll_reactor.hpp>
|
||||
#include <boost/asio/detail/kqueue_reactor.hpp>
|
||||
#include <boost/asio/detail/select_reactor.hpp>
|
||||
#include <boost/asio/detail/service_base.hpp>
|
||||
#include <boost/asio/detail/reactive_descriptor_service.hpp>
|
||||
|
||||
#if !defined(BOOST_ASIO_DISABLE_POSIX_STREAM_DESCRIPTOR)
|
||||
# if !defined(BOOST_WINDOWS) && !defined(__CYGWIN__)
|
||||
# define BOOST_ASIO_HAS_POSIX_STREAM_DESCRIPTOR 1
|
||||
# endif // !defined(BOOST_WINDOWS) && !defined(__CYGWIN__)
|
||||
#endif // !defined(BOOST_ASIO_DISABLE_POSIX_STREAM_DESCRIPTOR)
|
||||
|
||||
#if defined(BOOST_ASIO_HAS_POSIX_STREAM_DESCRIPTOR) \
|
||||
|| defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
namespace boost {
|
||||
namespace asio {
|
||||
namespace posix {
|
||||
|
||||
/// Default service implementation for a stream descriptor.
|
||||
class stream_descriptor_service
|
||||
#if defined(GENERATING_DOCUMENTATION)
|
||||
: public boost::asio::io_service::service
|
||||
#else
|
||||
: public boost::asio::detail::service_base<stream_descriptor_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_EPOLL)
|
||||
typedef detail::reactive_descriptor_service<
|
||||
detail::epoll_reactor<false> > service_impl_type;
|
||||
#elif defined(BOOST_ASIO_HAS_KQUEUE)
|
||||
typedef detail::reactive_descriptor_service<
|
||||
detail::kqueue_reactor<false> > service_impl_type;
|
||||
#elif defined(BOOST_ASIO_HAS_DEV_POLL)
|
||||
typedef detail::reactive_descriptor_service<
|
||||
detail::dev_poll_reactor<false> > service_impl_type;
|
||||
#else
|
||||
typedef detail::reactive_descriptor_service<
|
||||
detail::select_reactor<false> > service_impl_type;
|
||||
#endif
|
||||
|
||||
public:
|
||||
/// The type of a stream descriptor implementation.
|
||||
#if defined(GENERATING_DOCUMENTATION)
|
||||
typedef implementation_defined implementation_type;
|
||||
#else
|
||||
typedef service_impl_type::implementation_type implementation_type;
|
||||
#endif
|
||||
|
||||
/// The native descriptor type.
|
||||
#if defined(GENERATING_DOCUMENTATION)
|
||||
typedef implementation_defined native_type;
|
||||
#else
|
||||
typedef service_impl_type::native_type native_type;
|
||||
#endif
|
||||
|
||||
/// Construct a new stream descriptor service for the specified io_service.
|
||||
explicit stream_descriptor_service(boost::asio::io_service& io_service)
|
||||
: boost::asio::detail::service_base<stream_descriptor_service>(io_service),
|
||||
service_impl_(boost::asio::use_service<service_impl_type>(io_service))
|
||||
{
|
||||
}
|
||||
|
||||
/// Destroy all user-defined descriptorr objects owned by the service.
|
||||
void shutdown_service()
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct a new stream descriptor implementation.
|
||||
void construct(implementation_type& impl)
|
||||
{
|
||||
service_impl_.construct(impl);
|
||||
}
|
||||
|
||||
/// Destroy a stream descriptor implementation.
|
||||
void destroy(implementation_type& impl)
|
||||
{
|
||||
service_impl_.destroy(impl);
|
||||
}
|
||||
|
||||
/// Assign an existing native descriptor to a stream descriptor.
|
||||
boost::system::error_code assign(implementation_type& impl,
|
||||
const native_type& native_descriptor, boost::system::error_code& ec)
|
||||
{
|
||||
return service_impl_.assign(impl, native_descriptor, ec);
|
||||
}
|
||||
|
||||
/// Determine whether the descriptor is open.
|
||||
bool is_open(const implementation_type& impl) const
|
||||
{
|
||||
return service_impl_.is_open(impl);
|
||||
}
|
||||
|
||||
/// Close a stream descriptor implementation.
|
||||
boost::system::error_code close(implementation_type& impl,
|
||||
boost::system::error_code& ec)
|
||||
{
|
||||
return service_impl_.close(impl, ec);
|
||||
}
|
||||
|
||||
/// Get the native descriptor implementation.
|
||||
native_type native(implementation_type& impl)
|
||||
{
|
||||
return service_impl_.native(impl);
|
||||
}
|
||||
|
||||
/// Cancel all asynchronous operations associated with the descriptor.
|
||||
boost::system::error_code cancel(implementation_type& impl,
|
||||
boost::system::error_code& ec)
|
||||
{
|
||||
return service_impl_.cancel(impl, ec);
|
||||
}
|
||||
|
||||
/// Perform an IO control command on the descriptor.
|
||||
template <typename IoControlCommand>
|
||||
boost::system::error_code io_control(implementation_type& impl,
|
||||
IoControlCommand& command, boost::system::error_code& ec)
|
||||
{
|
||||
return service_impl_.io_control(impl, command, 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 descriptorr)
|
||||
{
|
||||
service_impl_.async_write_some(impl, buffers, descriptorr);
|
||||
}
|
||||
|
||||
/// 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 descriptorr)
|
||||
{
|
||||
service_impl_.async_read_some(impl, buffers, descriptorr);
|
||||
}
|
||||
|
||||
private:
|
||||
// The service that provides the platform-specific implementation.
|
||||
service_impl_type& service_impl_;
|
||||
};
|
||||
|
||||
} // namespace posix
|
||||
} // namespace asio
|
||||
} // namespace boost
|
||||
|
||||
#endif // defined(BOOST_ASIO_HAS_POSIX_STREAM_DESCRIPTOR)
|
||||
// || defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#include <boost/asio/detail/pop_options.hpp>
|
||||
|
||||
#endif // BOOST_ASIO_POSIX_STREAM_DESCRIPTOR_SERVICE_HPP
|
||||
Reference in New Issue
Block a user