| // |
| // 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 ASIO_POSIX_BASIC_STREAM_DESCRIPTOR_HPP |
| #define ASIO_POSIX_BASIC_STREAM_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 <cstddef> |
| #include <boost/config.hpp> |
| #include "asio/detail/pop_options.hpp" |
| |
| #include "asio/error.hpp" |
| #include "asio/posix/basic_descriptor.hpp" |
| #include "asio/posix/stream_descriptor_service.hpp" |
| #include "asio/detail/throw_error.hpp" |
| |
| #if defined(ASIO_HAS_POSIX_STREAM_DESCRIPTOR) \ |
| || defined(GENERATING_DOCUMENTATION) |
| |
| 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(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 asio::system_error Thrown on failure. |
| */ |
| basic_stream_descriptor(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 asio::system_error Thrown on failure. An error code of |
| * 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(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) |
| { |
| asio::error_code ec; |
| std::size_t s = this->service.write_some(this->implementation, buffers, ec); |
| 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, |
| asio::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 asio::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 |
| * 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(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 asio::system_error Thrown on failure. An error code of |
| * 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(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) |
| { |
| asio::error_code ec; |
| std::size_t s = this->service.read_some(this->implementation, buffers, ec); |
| 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, |
| asio::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 asio::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 |
| * 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(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 |
| |
| #endif // defined(ASIO_HAS_POSIX_STREAM_DESCRIPTOR) |
| // || defined(GENERATING_DOCUMENTATION) |
| |
| #include "asio/detail/pop_options.hpp" |
| |
| #endif // ASIO_POSIX_BASIC_STREAM_DESCRIPTOR_HPP |