diff options
Diffstat (limited to '3rdparty/asio/include/asio/posix/basic_stream_descriptor.hpp')
-rw-r--r-- | 3rdparty/asio/include/asio/posix/basic_stream_descriptor.hpp | 369 |
1 files changed, 283 insertions, 86 deletions
diff --git a/3rdparty/asio/include/asio/posix/basic_stream_descriptor.hpp b/3rdparty/asio/include/asio/posix/basic_stream_descriptor.hpp index eb7bc8bb975..9868dee1259 100644 --- a/3rdparty/asio/include/asio/posix/basic_stream_descriptor.hpp +++ b/3rdparty/asio/include/asio/posix/basic_stream_descriptor.hpp @@ -2,7 +2,7 @@ // posix/basic_stream_descriptor.hpp // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // -// Copyright (c) 2003-2016 Christopher M. Kohlhoff (chris at kohlhoff dot com) +// Copyright (c) 2003-2024 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/posix/basic_descriptor.hpp" #if defined(ASIO_HAS_POSIX_STREAM_DESCRIPTOR) \ || defined(GENERATING_DOCUMENTATION) -#include <cstddef> -#include "asio/detail/handler_type_requirements.hpp" -#include "asio/detail/throw_error.hpp" -#include "asio/error.hpp" -#include "asio/posix/basic_descriptor.hpp" -#include "asio/posix/stream_descriptor_service.hpp" - #include "asio/detail/push_options.hpp" namespace asio { @@ -43,87 +35,193 @@ namespace posix { * @e Distinct @e objects: Safe.@n * @e Shared @e objects: Unsafe. * + * Synchronous @c read_some and @c write_some operations are thread safe with + * respect to each other, if the underlying operating system calls are also + * thread safe. This means that it is permitted to perform concurrent calls to + * these synchronous operations on a single descriptor object. Other synchronous + * operations, such as @c close, are not thread safe. + * * @par Concepts: * AsyncReadStream, AsyncWriteStream, Stream, SyncReadStream, SyncWriteStream. */ -template <typename StreamDescriptorService = stream_descriptor_service> +template <typename Executor = any_io_executor> class basic_stream_descriptor - : public basic_descriptor<StreamDescriptorService> + : public basic_descriptor<Executor> { +private: + class initiate_async_write_some; + class initiate_async_read_some; + public: + /// The type of the executor associated with the object. + typedef Executor executor_type; + + /// Rebinds the descriptor type to another executor. + template <typename Executor1> + struct rebind_executor + { + /// The descriptor type when rebound to the specified executor. + typedef basic_stream_descriptor<Executor1> other; + }; + /// The native representation of a descriptor. - typedef typename StreamDescriptorService::native_handle_type + typedef typename basic_descriptor<Executor>::native_handle_type native_handle_type; - /// Construct a basic_stream_descriptor without opening it. + /// Construct a 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_context The io_context object that the stream descriptor will - * use to dispatch handlers for any asynchronous operations performed on the + * @param ex The I/O executor that the descriptor will use, by default, to + * dispatch handlers for any asynchronous operations performed on the * descriptor. */ - explicit basic_stream_descriptor(asio::io_context& io_context) - : basic_descriptor<StreamDescriptorService>(io_context) + explicit basic_stream_descriptor(const executor_type& ex) + : basic_descriptor<Executor>(ex) + { + } + + /// Construct a 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 context An execution context which provides the I/O executor that + * the descriptor will use, by default, to dispatch handlers for any + * asynchronous operations performed on the descriptor. + */ + template <typename ExecutionContext> + explicit basic_stream_descriptor(ExecutionContext& context, + constraint_t< + is_convertible<ExecutionContext&, execution_context&>::value, + defaulted_constraint + > = defaulted_constraint()) + : basic_descriptor<Executor>(context) { } - /// Construct a basic_stream_descriptor on an existing native descriptor. + /// Construct a stream descriptor on an existing native descriptor. /** * This constructor creates a stream descriptor object to hold an existing * native descriptor. * - * @param io_context The io_context object that the stream descriptor will - * use to dispatch handlers for any asynchronous operations performed on the + * @param ex The I/O executor that the descriptor will use, by default, 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_context& io_context, + basic_stream_descriptor(const executor_type& ex, const native_handle_type& native_descriptor) - : basic_descriptor<StreamDescriptorService>(io_context, native_descriptor) + : basic_descriptor<Executor>(ex, native_descriptor) + { + } + + /// Construct a stream descriptor on an existing native descriptor. + /** + * This constructor creates a stream descriptor object to hold an existing + * native descriptor. + * + * @param context An execution context which provides the I/O executor that + * the descriptor will use, by default, 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. + */ + template <typename ExecutionContext> + basic_stream_descriptor(ExecutionContext& context, + const native_handle_type& native_descriptor, + constraint_t< + is_convertible<ExecutionContext&, execution_context&>::value + > = 0) + : basic_descriptor<Executor>(context, native_descriptor) { } -#if defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION) - /// Move-construct a basic_stream_descriptor from another. + /// Move-construct a stream descriptor from another. /** * This constructor moves a stream descriptor from one object to another. * - * @param other The other basic_stream_descriptor object from which the move + * @param other The other stream descriptor 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_descriptor(io_context&) constructor. + * constructed using the @c basic_stream_descriptor(const executor_type&) + * constructor. */ - basic_stream_descriptor(basic_stream_descriptor&& other) - : basic_descriptor<StreamDescriptorService>( - ASIO_MOVE_CAST(basic_stream_descriptor)(other)) + basic_stream_descriptor(basic_stream_descriptor&& other) noexcept + : basic_descriptor<Executor>(std::move(other)) { } - /// Move-assign a basic_stream_descriptor from another. + /// Move-assign a stream descriptor from another. /** * This assignment operator moves a stream descriptor from one object to * another. * - * @param other The other basic_stream_descriptor object from which the move + * @param other The other stream descriptor 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_descriptor(io_context&) constructor. + * constructed using the @c basic_stream_descriptor(const executor_type&) + * constructor. */ basic_stream_descriptor& operator=(basic_stream_descriptor&& other) { - basic_descriptor<StreamDescriptorService>::operator=( - ASIO_MOVE_CAST(basic_stream_descriptor)(other)); + basic_descriptor<Executor>::operator=(std::move(other)); + return *this; + } + + /// Move-construct a basic_stream_descriptor from a descriptor of another + /// executor type. + /** + * This constructor moves a descriptor from one object to another. + * + * @param other The other basic_stream_descriptor 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_descriptor(const executor_type&) + * constructor. + */ + template <typename Executor1> + basic_stream_descriptor(basic_stream_descriptor<Executor1>&& other, + constraint_t< + is_convertible<Executor1, Executor>::value, + defaulted_constraint + > = defaulted_constraint()) + : basic_descriptor<Executor>(std::move(other)) + { + } + + /// Move-assign a basic_stream_descriptor from a descriptor of another + /// executor type. + /** + * This assignment operator moves a descriptor from one object to another. + * + * @param other The other basic_stream_descriptor 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_descriptor(const executor_type&) + * constructor. + */ + template <typename Executor1> + constraint_t< + is_convertible<Executor1, Executor>::value, + basic_stream_descriptor& + > operator=(basic_stream_descriptor<Executor1> && other) + { + basic_descriptor<Executor>::operator=(std::move(other)); return *this; } -#endif // defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION) /// Write some data to the descriptor. /** @@ -156,8 +254,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; } @@ -182,31 +280,37 @@ 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. /** * This function is used to asynchronously write data to the stream - * descriptor. The function call always returns immediately. + * descriptor. It is an initiating function for an @ref + * asynchronous_operation, and 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. + * that they remain valid until the completion 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: + * @param token The @ref completion_token that will be used to produce a + * completion handler, which will be called when the write completes. + * Potential completion tokens include @ref use_future, @ref use_awaitable, + * @ref yield_context, or a function object with the correct completion + * signature. The function signature of the completion handler must be: * @code void handler( * const asio::error_code& error, // Result of operation. - * std::size_t bytes_transferred // Number of bytes written. + * 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 completion 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(). + * + * @par Completion Signature + * @code void(asio::error_code, std::size_t) @endcode * * @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 @@ -220,19 +324,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, - void (asio::error_code, std::size_t)) - async_write_some(const ConstBufferSequence& buffers, - ASIO_MOVE_ARG(WriteHandler) handler) + template <typename ConstBufferSequence, + ASIO_COMPLETION_TOKEN_FOR(void (asio::error_code, + std::size_t)) WriteToken = default_completion_token_t<executor_type>> + auto async_write_some(const ConstBufferSequence& buffers, + WriteToken&& token = default_completion_token_t<executor_type>()) + -> decltype( + async_initiate<WriteToken, + void (asio::error_code, std::size_t)>( + initiate_async_write_some(this), token, buffers)) { - // 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<WriteToken, + void (asio::error_code, std::size_t)>( + initiate_async_write_some(this), token, buffers); } /// Read some data from the descriptor. @@ -267,8 +382,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; } @@ -294,31 +409,37 @@ 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. /** * This function is used to asynchronously read data from the stream - * descriptor. The function call always returns immediately. + * descriptor. It is an initiating function for an @ref + * asynchronous_operation, and 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. + * that they remain valid until the completion 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: + * @param token The @ref completion_token that will be used to produce a + * completion handler, which will be called when the read completes. + * Potential completion tokens include @ref use_future, @ref use_awaitable, + * @ref yield_context, or a function object with the correct completion + * signature. The function signature of the completion handler must be: * @code void handler( * const asio::error_code& error, // Result of operation. - * std::size_t bytes_transferred // Number of bytes read. + * 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 completion 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(). + * + * @par Completion Signature + * @code void(asio::error_code, std::size_t) @endcode * * @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 @@ -333,20 +454,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, - void (asio::error_code, std::size_t)) - async_read_some(const MutableBufferSequence& buffers, - ASIO_MOVE_ARG(ReadHandler) handler) + template <typename MutableBufferSequence, + ASIO_COMPLETION_TOKEN_FOR(void (asio::error_code, + std::size_t)) ReadToken = default_completion_token_t<executor_type>> + auto async_read_some(const MutableBufferSequence& buffers, + ReadToken&& token = default_completion_token_t<executor_type>()) + -> decltype( + async_initiate<ReadToken, + void (asio::error_code, std::size_t)>( + declval<initiate_async_read_some>(), token, buffers)) { - // 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<ReadToken, + void (asio::error_code, std::size_t)>( + initiate_async_read_some(this), token, buffers); } + +private: + class initiate_async_write_some + { + public: + typedef Executor executor_type; + + explicit initiate_async_write_some(basic_stream_descriptor* self) + : self_(self) + { + } + + const executor_type& get_executor() const noexcept + { + return self_->get_executor(); + } + + template <typename WriteHandler, typename ConstBufferSequence> + void operator()(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_descriptor* self_; + }; + + class initiate_async_read_some + { + public: + typedef Executor executor_type; + + explicit initiate_async_read_some(basic_stream_descriptor* self) + : self_(self) + { + } + + const executor_type& get_executor() const noexcept + { + return self_->get_executor(); + } + + template <typename ReadHandler, typename MutableBufferSequence> + void operator()(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_descriptor* self_; + }; }; } // namespace posix @@ -357,6 +556,4 @@ public: #endif // defined(ASIO_HAS_POSIX_STREAM_DESCRIPTOR) // || defined(GENERATING_DOCUMENTATION) -#endif // defined(ASIO_ENABLE_OLD_SERVICES) - #endif // ASIO_POSIX_BASIC_STREAM_DESCRIPTOR_HPP |