diff options
Diffstat (limited to '3rdparty/asio/include/asio/windows/basic_stream_handle.hpp')
-rw-r--r-- | 3rdparty/asio/include/asio/windows/basic_stream_handle.hpp | 281 |
1 files changed, 208 insertions, 73 deletions
diff --git a/3rdparty/asio/include/asio/windows/basic_stream_handle.hpp b/3rdparty/asio/include/asio/windows/basic_stream_handle.hpp index c0a11fcf1af..1a35224a234 100644 --- a/3rdparty/asio/include/asio/windows/basic_stream_handle.hpp +++ b/3rdparty/asio/include/asio/windows/basic_stream_handle.hpp @@ -2,7 +2,7 @@ // windows/basic_stream_handle.hpp // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // -// Copyright (c) 2003-2016 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// Copyright (c) 2003-2021 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) @@ -16,19 +16,11 @@ #endif // defined(_MSC_VER) && (_MSC_VER >= 1200) #include "asio/detail/config.hpp" - -#if defined(ASIO_ENABLE_OLD_SERVICES) +#include "asio/windows/basic_overlapped_handle.hpp" #if defined(ASIO_HAS_WINDOWS_STREAM_HANDLE) \ || defined(GENERATING_DOCUMENTATION) -#include <cstddef> -#include "asio/detail/handler_type_requirements.hpp" -#include "asio/detail/throw_error.hpp" -#include "asio/error.hpp" -#include "asio/windows/basic_handle.hpp" -#include "asio/windows/stream_handle_service.hpp" - #include "asio/detail/push_options.hpp" namespace asio { @@ -36,8 +28,8 @@ namespace windows { /// Provides stream-oriented handle functionality. /** - * The windows::basic_stream_handle class template provides asynchronous and - * blocking stream-oriented handle functionality. + * The windows::basic_stream_handle class provides asynchronous and blocking + * stream-oriented handle functionality. * * @par Thread Safety * @e Distinct @e objects: Safe.@n @@ -46,78 +38,134 @@ namespace windows { * @par Concepts: * AsyncReadStream, AsyncWriteStream, Stream, SyncReadStream, SyncWriteStream. */ -template <typename StreamHandleService = stream_handle_service> +template <typename Executor = any_io_executor> class basic_stream_handle - : public basic_handle<StreamHandleService> + : public basic_overlapped_handle<Executor> { public: + /// The type of the executor associated with the object. + typedef Executor executor_type; + + /// Rebinds the handle type to another executor. + template <typename Executor1> + struct rebind_executor + { + /// The handle type when rebound to the specified executor. + typedef basic_stream_handle<Executor1> other; + }; + /// The native representation of a handle. - typedef typename StreamHandleService::native_handle_type native_handle_type; +#if defined(GENERATING_DOCUMENTATION) + typedef implementation_defined native_handle_type; +#else + typedef asio::detail::win_iocp_handle_service::native_handle_type + native_handle_type; +#endif - /// Construct a basic_stream_handle without opening it. + /// Construct a stream handle without opening it. + /** + * This constructor creates a stream handle without opening it. + * + * @param ex The I/O executor that the stream handle will use, by default, to + * dispatch handlers for any asynchronous operations performed on the stream + * handle. + */ + explicit basic_stream_handle(const executor_type& ex) + : basic_overlapped_handle<Executor>(ex) + { + } + + /// Construct a stream handle without opening it. /** * This constructor creates a stream handle without opening it. The handle - * needs to be opened and then connected or accepted before data can be sent - * or received on it. + * needs to be opened or assigned before data can be sent or received on it. + * + * @param context An execution context which provides the I/O executor that + * the stream handle will use, by default, to dispatch handlers for any + * asynchronous operations performed on the stream handle. + */ + template <typename ExecutionContext> + explicit basic_stream_handle(ExecutionContext& context, + typename constraint< + is_convertible<ExecutionContext&, execution_context&>::value, + defaulted_constraint + >::type = defaulted_constraint()) + : basic_overlapped_handle<Executor>(context) + { + } + + /// Construct a stream handle on an existing native handle. + /** + * This constructor creates a stream handle object to hold an existing native + * handle. * - * @param io_context The io_context object that the stream handle will use to - * dispatch handlers for any asynchronous operations performed on the handle. + * @param ex The I/O executor that the stream handle will use, by default, to + * dispatch handlers for any asynchronous operations performed on the stream + * handle. + * + * @param handle The new underlying handle implementation. + * + * @throws asio::system_error Thrown on failure. */ - explicit basic_stream_handle(asio::io_context& io_context) - : basic_handle<StreamHandleService>(io_context) + basic_stream_handle(const executor_type& ex, const native_handle_type& handle) + : basic_overlapped_handle<Executor>(ex, handle) { } - /// Construct a basic_stream_handle on an existing native handle. + /// Construct a stream handle on an existing native handle. /** * This constructor creates a stream handle object to hold an existing native * handle. * - * @param io_context The io_context object that the stream handle will use to - * dispatch handlers for any asynchronous operations performed on the handle. + * @param context An execution context which provides the I/O executor that + * the stream handle will use, by default, to dispatch handlers for any + * asynchronous operations performed on the stream handle. * * @param handle The new underlying handle implementation. * * @throws asio::system_error Thrown on failure. */ - basic_stream_handle(asio::io_context& io_context, - const native_handle_type& handle) - : basic_handle<StreamHandleService>(io_context, handle) + template <typename ExecutionContext> + basic_stream_handle(ExecutionContext& context, + const native_handle_type& handle, + typename constraint< + is_convertible<ExecutionContext&, execution_context&>::value + >::type = 0) + : basic_overlapped_handle<Executor>(context, handle) { } #if defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION) - /// Move-construct a basic_stream_handle from another. + /// Move-construct a stream handle from another. /** * This constructor moves a stream handle from one object to another. * - * @param other The other basic_stream_handle object from which the move + * @param other The other stream handle object from which the move * will occur. * * @note Following the move, the moved-from object is in the same state as if - * constructed using the @c basic_stream_handle(io_context&) constructor. + * constructed using the @c basic_stream_handle(const executor_type&) + * constructor. */ basic_stream_handle(basic_stream_handle&& other) - : basic_handle<StreamHandleService>( - ASIO_MOVE_CAST(basic_stream_handle)(other)) + : basic_overlapped_handle<Executor>(std::move(other)) { } - /// Move-assign a basic_stream_handle from another. + /// Move-assign a stream handle from another. /** * This assignment operator moves a stream handle from one object to * another. * - * @param other The other basic_stream_handle object from which the move - * will occur. + * @param other The other stream handle object from which the move will occur. * * @note Following the move, the moved-from object is in the same state as if - * constructed using the @c basic_stream_handle(io_context&) constructor. + * constructed using the @c basic_stream_handle(const executor_type&) + * constructor. */ basic_stream_handle& operator=(basic_stream_handle&& other) { - basic_handle<StreamHandleService>::operator=( - ASIO_MOVE_CAST(basic_stream_handle)(other)); + basic_overlapped_handle<Executor>::operator=(std::move(other)); return *this; } #endif // defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION) @@ -153,8 +201,8 @@ public: std::size_t write_some(const ConstBufferSequence& buffers) { asio::error_code ec; - std::size_t s = this->get_service().write_some( - this->get_implementation(), buffers, ec); + std::size_t s = this->impl_.get_service().write_some( + this->impl_.get_implementation(), buffers, ec); asio::detail::throw_error(ec, "write_some"); return s; } @@ -179,8 +227,8 @@ public: std::size_t write_some(const ConstBufferSequence& buffers, asio::error_code& ec) { - return this->get_service().write_some( - this->get_implementation(), buffers, ec); + return this->impl_.get_service().write_some( + this->impl_.get_implementation(), buffers, ec); } /// Start an asynchronous write. @@ -201,9 +249,9 @@ public: * 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_context::post(). + * not, the handler will not be invoked from within this function. On + * immediate completion, invocation of the handler will be performed in a + * manner equivalent to using asio::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 @@ -217,19 +265,30 @@ public: * 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. + * + * @par Per-Operation Cancellation + * This asynchronous operation supports cancellation for the following + * asio::cancellation_type values: + * + * @li @c cancellation_type::terminal + * + * @li @c cancellation_type::partial + * + * @li @c cancellation_type::total */ - template <typename ConstBufferSequence, typename WriteHandler> - ASIO_INITFN_RESULT_TYPE(WriteHandler, + template <typename ConstBufferSequence, + ASIO_COMPLETION_TOKEN_FOR(void (asio::error_code, + std::size_t)) WriteHandler + ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)> + ASIO_INITFN_AUTO_RESULT_TYPE(WriteHandler, void (asio::error_code, std::size_t)) async_write_some(const ConstBufferSequence& buffers, - ASIO_MOVE_ARG(WriteHandler) handler) + ASIO_MOVE_ARG(WriteHandler) handler + ASIO_DEFAULT_COMPLETION_TOKEN(executor_type)) { - // If you get an error on the following line it means that your handler does - // not meet the documented type requirements for a WriteHandler. - ASIO_WRITE_HANDLER_CHECK(WriteHandler, handler) type_check; - - return this->get_service().async_write_some(this->get_implementation(), - buffers, ASIO_MOVE_CAST(WriteHandler)(handler)); + return async_initiate<WriteHandler, + void (asio::error_code, std::size_t)>( + initiate_async_write_some(this), handler, buffers); } /// Read some data from the handle. @@ -264,8 +323,8 @@ public: std::size_t read_some(const MutableBufferSequence& buffers) { asio::error_code ec; - std::size_t s = this->get_service().read_some( - this->get_implementation(), buffers, ec); + std::size_t s = this->impl_.get_service().read_some( + this->impl_.get_implementation(), buffers, ec); asio::detail::throw_error(ec, "read_some"); return s; } @@ -291,8 +350,8 @@ public: std::size_t read_some(const MutableBufferSequence& buffers, asio::error_code& ec) { - return this->get_service().read_some( - this->get_implementation(), buffers, ec); + return this->impl_.get_service().read_some( + this->impl_.get_implementation(), buffers, ec); } /// Start an asynchronous read. @@ -313,9 +372,9 @@ public: * 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_context::post(). + * not, the handler will not be invoked from within this function. On + * immediate completion, invocation of the handler will be performed in a + * manner equivalent to using asio::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 @@ -330,20 +389,98 @@ public: * 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. + * + * @par Per-Operation Cancellation + * This asynchronous operation supports cancellation for the following + * asio::cancellation_type values: + * + * @li @c cancellation_type::terminal + * + * @li @c cancellation_type::partial + * + * @li @c cancellation_type::total */ - template <typename MutableBufferSequence, typename ReadHandler> - ASIO_INITFN_RESULT_TYPE(ReadHandler, + template <typename MutableBufferSequence, + ASIO_COMPLETION_TOKEN_FOR(void (asio::error_code, + std::size_t)) ReadHandler + ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)> + ASIO_INITFN_AUTO_RESULT_TYPE(ReadHandler, void (asio::error_code, std::size_t)) async_read_some(const MutableBufferSequence& buffers, - ASIO_MOVE_ARG(ReadHandler) handler) + ASIO_MOVE_ARG(ReadHandler) handler + ASIO_DEFAULT_COMPLETION_TOKEN(executor_type)) { - // If you get an error on the following line it means that your handler does - // not meet the documented type requirements for a ReadHandler. - ASIO_READ_HANDLER_CHECK(ReadHandler, handler) type_check; - - return this->get_service().async_read_some(this->get_implementation(), - buffers, ASIO_MOVE_CAST(ReadHandler)(handler)); + return async_initiate<ReadHandler, + void (asio::error_code, std::size_t)>( + initiate_async_read_some(this), handler, buffers); } + +private: + class initiate_async_write_some + { + public: + typedef Executor executor_type; + + explicit initiate_async_write_some(basic_stream_handle* self) + : self_(self) + { + } + + executor_type get_executor() const ASIO_NOEXCEPT + { + return self_->get_executor(); + } + + template <typename WriteHandler, typename ConstBufferSequence> + void operator()(ASIO_MOVE_ARG(WriteHandler) handler, + const ConstBufferSequence& buffers) const + { + // If you get an error on the following line it means that your handler + // does not meet the documented type requirements for a WriteHandler. + ASIO_WRITE_HANDLER_CHECK(WriteHandler, handler) type_check; + + detail::non_const_lvalue<WriteHandler> handler2(handler); + self_->impl_.get_service().async_write_some( + self_->impl_.get_implementation(), buffers, + handler2.value, self_->impl_.get_executor()); + } + + private: + basic_stream_handle* self_; + }; + + class initiate_async_read_some + { + public: + typedef Executor executor_type; + + explicit initiate_async_read_some(basic_stream_handle* self) + : self_(self) + { + } + + executor_type get_executor() const ASIO_NOEXCEPT + { + return self_->get_executor(); + } + + template <typename ReadHandler, typename MutableBufferSequence> + void operator()(ASIO_MOVE_ARG(ReadHandler) handler, + const MutableBufferSequence& buffers) const + { + // If you get an error on the following line it means that your handler + // does not meet the documented type requirements for a ReadHandler. + ASIO_READ_HANDLER_CHECK(ReadHandler, handler) type_check; + + detail::non_const_lvalue<ReadHandler> handler2(handler); + self_->impl_.get_service().async_read_some( + self_->impl_.get_implementation(), buffers, + handler2.value, self_->impl_.get_executor()); + } + + private: + basic_stream_handle* self_; + }; }; } // namespace windows @@ -354,6 +491,4 @@ public: #endif // defined(ASIO_HAS_WINDOWS_STREAM_HANDLE) // || defined(GENERATING_DOCUMENTATION) -#endif // defined(ASIO_ENABLE_OLD_SERVICES) - #endif // ASIO_WINDOWS_BASIC_STREAM_HANDLE_HPP |