// // deferred.hpp // ~~~~~~~~~~~~ // // Copyright (c) 2003-2023 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_DEFERRED_HPP #define ASIO_DEFERRED_HPP #if defined(_MSC_VER) && (_MSC_VER >= 1200) # pragma once #endif // defined(_MSC_VER) && (_MSC_VER >= 1200) #include "asio/detail/config.hpp" #if (defined(ASIO_HAS_STD_TUPLE) \ && defined(ASIO_HAS_DECLTYPE) \ && defined(ASIO_HAS_VARIADIC_TEMPLATES)) \ || defined(GENERATING_DOCUMENTATION) #include #include "asio/associator.hpp" #include "asio/async_result.hpp" #include "asio/detail/type_traits.hpp" #include "asio/detail/utility.hpp" #include "asio/detail/push_options.hpp" namespace asio { /// Trait for detecting objects that are usable as deferred operations. template struct is_deferred : false_type { }; /// Helper type to wrap multiple completion signatures. template struct deferred_signatures { }; namespace detail { // Helper trait for getting the completion signatures of the tail in a sequence // when invoked with the specified arguments. template struct deferred_sequence_signatures; template struct deferred_sequence_signatures : completion_signature_of()(declval()...))> { static_assert( !is_same()(declval()...)), void>::value, "deferred functions must produce a deferred return type"); }; // Completion handler for the head component of a deferred sequence. template class deferred_sequence_handler { public: template explicit deferred_sequence_handler( ASIO_MOVE_ARG(H) handler, ASIO_MOVE_ARG(T) tail) : handler_(ASIO_MOVE_CAST(H)(handler)), tail_(ASIO_MOVE_CAST(T)(tail)) { } template void operator()(ASIO_MOVE_ARG(Args)... args) { ASIO_MOVE_OR_LVALUE(Tail)(tail_)( ASIO_MOVE_CAST(Args)(args)...)( ASIO_MOVE_OR_LVALUE(Handler)(handler_)); } //private: Handler handler_; Tail tail_; }; template class deferred_sequence_base { private: struct initiate { template void operator()(ASIO_MOVE_ARG(Handler) handler, Head head, ASIO_MOVE_ARG(Tail) tail) { ASIO_MOVE_OR_LVALUE(Head)(head)( deferred_sequence_handler< typename decay::type, typename decay::type>( ASIO_MOVE_CAST(Handler)(handler), ASIO_MOVE_CAST(Tail)(tail))); } }; Head head_; Tail tail_; public: template ASIO_CONSTEXPR explicit deferred_sequence_base( ASIO_MOVE_ARG(H) head, ASIO_MOVE_ARG(T) tail) : head_(ASIO_MOVE_CAST(H)(head)), tail_(ASIO_MOVE_CAST(T)(tail)) { } template auto operator()( ASIO_MOVE_ARG(CompletionToken) token) ASIO_RVALUE_REF_QUAL -> decltype( asio::async_initiate( declval(), token, ASIO_MOVE_OR_LVALUE(Head)(this->head_), ASIO_MOVE_OR_LVALUE(Tail)(this->tail_))) { return asio::async_initiate( initiate(), token, ASIO_MOVE_OR_LVALUE(Head)(head_), ASIO_MOVE_OR_LVALUE(Tail)(tail_)); } #if defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) template auto operator()( ASIO_MOVE_ARG(CompletionToken) token) const & -> decltype( asio::async_initiate( initiate(), token, this->head_, this->tail_)) { return asio::async_initiate( initiate(), token, head_, tail_); } #endif // defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) }; // Two-step application of variadic Signatures to determine correct base type. template struct deferred_sequence_types { template struct op1 { typedef deferred_sequence_base type; }; template struct op2 { typedef typename deferred_sequence_signatures::template apply::type::type type; }; typedef typename completion_signature_of::template apply::type::type base; }; } // namespace detail /// Used to represent an empty deferred action. struct deferred_noop { /// No effect. template void operator()(ASIO_MOVE_ARG(Args)...) ASIO_RVALUE_REF_QUAL { } #if defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) /// No effect. template void operator()(ASIO_MOVE_ARG(Args)...) const & { } #endif // defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) }; #if !defined(GENERATING_DOCUMENTATION) template <> struct is_deferred : true_type { }; #endif // !defined(GENERATING_DOCUMENTATION) /// Tag type to disambiguate deferred constructors. struct deferred_init_tag {}; /// Wraps a function object so that it may be used as an element in a deferred /// composition. template class deferred_function { public: /// Constructor. template ASIO_CONSTEXPR explicit deferred_function( deferred_init_tag, ASIO_MOVE_ARG(F) function) : function_(ASIO_MOVE_CAST(F)(function)) { } //private: Function function_; public: template auto operator()( ASIO_MOVE_ARG(Args)... args) ASIO_RVALUE_REF_QUAL -> decltype( ASIO_MOVE_CAST(Function)(this->function_)( ASIO_MOVE_CAST(Args)(args)...)) { return ASIO_MOVE_CAST(Function)(function_)( ASIO_MOVE_CAST(Args)(args)...); } #if defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) template auto operator()( ASIO_MOVE_ARG(Args)... args) const & -> decltype(Function(function_)(ASIO_MOVE_CAST(Args)(args)...)) { return Function(function_)(ASIO_MOVE_CAST(Args)(args)...); } #endif // defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) }; #if !defined(GENERATING_DOCUMENTATION) template struct is_deferred > : true_type { }; #endif // !defined(GENERATING_DOCUMENTATION) /// Encapsulates deferred values. template class ASIO_NODISCARD deferred_values { private: std::tuple values_; struct initiate { template void operator()(Handler handler, ASIO_MOVE_ARG(V)... values) { ASIO_MOVE_OR_LVALUE(Handler)(handler)( ASIO_MOVE_CAST(V)(values)...); } }; template auto invoke_helper( ASIO_MOVE_ARG(CompletionToken) token, detail::index_sequence) -> decltype( asio::async_initiate( initiate(), token, std::get( ASIO_MOVE_CAST(std::tuple)(this->values_))...)) { return asio::async_initiate( initiate(), token, std::get(ASIO_MOVE_CAST(std::tuple)(values_))...); } #if defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) template auto const_invoke_helper( ASIO_MOVE_ARG(CompletionToken) token, detail::index_sequence) -> decltype( asio::async_initiate( initiate(), token, std::get(values_)...)) { return asio::async_initiate( initiate(), token, std::get(values_)...); } #endif // defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) public: /// Construct a deferred asynchronous operation from the arguments to an /// initiation function object. template ASIO_CONSTEXPR explicit deferred_values( deferred_init_tag, ASIO_MOVE_ARG(V)... values) : values_(ASIO_MOVE_CAST(V)(values)...) { } /// Initiate the deferred operation using the supplied completion token. template auto operator()( ASIO_MOVE_ARG(CompletionToken) token) ASIO_RVALUE_REF_QUAL -> decltype( this->invoke_helper( ASIO_MOVE_CAST(CompletionToken)(token), detail::index_sequence_for())) { return this->invoke_helper( ASIO_MOVE_CAST(CompletionToken)(token), detail::index_sequence_for()); } #if defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) template auto operator()( ASIO_MOVE_ARG(CompletionToken) token) const & -> decltype( this->const_invoke_helper( ASIO_MOVE_CAST(CompletionToken)(token), detail::index_sequence_for())) { return this->const_invoke_helper( ASIO_MOVE_CAST(CompletionToken)(token), detail::index_sequence_for()); } #endif // defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) }; #if !defined(GENERATING_DOCUMENTATION) template struct is_deferred > : true_type { }; #endif // !defined(GENERATING_DOCUMENTATION) /// Encapsulates a deferred asynchronous operation. template class ASIO_NODISCARD deferred_async_operation { private: typedef typename decay::type initiation_t; initiation_t initiation_; typedef std::tuple::type...> init_args_t; init_args_t init_args_; template auto invoke_helper( ASIO_MOVE_ARG(CompletionToken) token, detail::index_sequence) -> decltype( asio::async_initiate( ASIO_MOVE_CAST(initiation_t)(initiation_), token, std::get(ASIO_MOVE_CAST(init_args_t)(init_args_))...)) { return asio::async_initiate( ASIO_MOVE_CAST(initiation_t)(initiation_), token, std::get(ASIO_MOVE_CAST(init_args_t)(init_args_))...); } #if defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) template auto const_invoke_helper( ASIO_MOVE_ARG(CompletionToken) token, detail::index_sequence) const & -> decltype( asio::async_initiate( initiation_t(initiation_), token, std::get(init_args_)...)) { return asio::async_initiate( initiation_t(initiation_), token, std::get(init_args_)...); } #endif // defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) public: /// Construct a deferred asynchronous operation from the arguments to an /// initiation function object. template ASIO_CONSTEXPR explicit deferred_async_operation( deferred_init_tag, ASIO_MOVE_ARG(I) initiation, ASIO_MOVE_ARG(A)... init_args) : initiation_(ASIO_MOVE_CAST(I)(initiation)), init_args_(ASIO_MOVE_CAST(A)(init_args)...) { } /// Initiate the asynchronous operation using the supplied completion token. template auto operator()( ASIO_MOVE_ARG(CompletionToken) token) ASIO_RVALUE_REF_QUAL -> decltype( this->invoke_helper( ASIO_MOVE_CAST(CompletionToken)(token), detail::index_sequence_for())) { return this->invoke_helper( ASIO_MOVE_CAST(CompletionToken)(token), detail::index_sequence_for()); } #if defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) template auto operator()( ASIO_MOVE_ARG(CompletionToken) token) const & -> decltype( this->const_invoke_helper( ASIO_MOVE_CAST(CompletionToken)(token), detail::index_sequence_for())) { return this->const_invoke_helper( ASIO_MOVE_CAST(CompletionToken)(token), detail::index_sequence_for()); } #endif // defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) }; /// Encapsulates a deferred asynchronous operation thas has multiple completion /// signatures. template class ASIO_NODISCARD deferred_async_operation< deferred_signatures, Initiation, InitArgs...> { private: typedef typename decay::type initiation_t; initiation_t initiation_; typedef std::tuple::type...> init_args_t; init_args_t init_args_; template auto invoke_helper( ASIO_MOVE_ARG(CompletionToken) token, detail::index_sequence) -> decltype( asio::async_initiate( ASIO_MOVE_CAST(initiation_t)(initiation_), token, std::get(ASIO_MOVE_CAST(init_args_t)(init_args_))...)) { return asio::async_initiate( ASIO_MOVE_CAST(initiation_t)(initiation_), token, std::get(ASIO_MOVE_CAST(init_args_t)(init_args_))...); } #if defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) template auto const_invoke_helper( ASIO_MOVE_ARG(CompletionToken) token, detail::index_sequence) const & -> decltype( asio::async_initiate( initiation_t(initiation_), token, std::get(init_args_)...)) { return asio::async_initiate( initiation_t(initiation_), token, std::get(init_args_)...); } #endif // defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) public: /// Construct a deferred asynchronous operation from the arguments to an /// initiation function object. template ASIO_CONSTEXPR explicit deferred_async_operation( deferred_init_tag, ASIO_MOVE_ARG(I) initiation, ASIO_MOVE_ARG(A)... init_args) : initiation_(ASIO_MOVE_CAST(I)(initiation)), init_args_(ASIO_MOVE_CAST(A)(init_args)...) { } /// Initiate the asynchronous operation using the supplied completion token. template auto operator()( ASIO_MOVE_ARG(CompletionToken) token) ASIO_RVALUE_REF_QUAL -> decltype( this->invoke_helper( ASIO_MOVE_CAST(CompletionToken)(token), detail::index_sequence_for())) { return this->invoke_helper( ASIO_MOVE_CAST(CompletionToken)(token), detail::index_sequence_for()); } #if defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) template auto operator()( ASIO_MOVE_ARG(CompletionToken) token) const & -> decltype( this->const_invoke_helper( ASIO_MOVE_CAST(CompletionToken)(token), detail::index_sequence_for())) { return this->const_invoke_helper( ASIO_MOVE_CAST(CompletionToken)(token), detail::index_sequence_for()); } #endif // defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) }; #if !defined(GENERATING_DOCUMENTATION) template struct is_deferred< deferred_async_operation > : true_type { }; #endif // !defined(GENERATING_DOCUMENTATION) /// Defines a link between two consecutive operations in a sequence. template class ASIO_NODISCARD deferred_sequence : public detail::deferred_sequence_types::base { public: template ASIO_CONSTEXPR explicit deferred_sequence(deferred_init_tag, ASIO_MOVE_ARG(H) head, ASIO_MOVE_ARG(T) tail) : detail::deferred_sequence_types::base( ASIO_MOVE_CAST(H)(head), ASIO_MOVE_CAST(T)(tail)) { } #if defined(GENERATING_DOCUMENTATION) template auto operator()(ASIO_MOVE_ARG(CompletionToken) token) ASIO_RVALUE_REF_QUAL; template auto operator()(ASIO_MOVE_ARG(CompletionToken) token) const &; #endif // defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) }; #if !defined(GENERATING_DOCUMENTATION) template struct is_deferred > : true_type { }; #endif // !defined(GENERATING_DOCUMENTATION) /// Used to represent a deferred conditional branch. template class ASIO_NODISCARD deferred_conditional { private: template friend class deferred_conditional; // Helper constructor. template explicit deferred_conditional(bool b, ASIO_MOVE_ARG(T) on_true, ASIO_MOVE_ARG(F) on_false) : on_true_(ASIO_MOVE_CAST(T)(on_true)), on_false_(ASIO_MOVE_CAST(F)(on_false)), bool_(b) { } OnTrue on_true_; OnFalse on_false_; bool bool_; public: /// Construct a deferred conditional with the value to determine which branch /// will be executed. ASIO_CONSTEXPR explicit deferred_conditional(bool b) : on_true_(), on_false_(), bool_(b) { } /// Invoke the conditional branch bsaed on the stored alue. template auto operator()(ASIO_MOVE_ARG(Args)... args) ASIO_RVALUE_REF_QUAL -> decltype( ASIO_MOVE_OR_LVALUE(OnTrue)(on_true_)( ASIO_MOVE_CAST(Args)(args)...)) { if (bool_) { return ASIO_MOVE_OR_LVALUE(OnTrue)(on_true_)( ASIO_MOVE_CAST(Args)(args)...); } else { return ASIO_MOVE_OR_LVALUE(OnFalse)(on_false_)( ASIO_MOVE_CAST(Args)(args)...); } } #if defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) template auto operator()(ASIO_MOVE_ARG(Args)... args) const & -> decltype(on_true_(ASIO_MOVE_CAST(Args)(args)...)) { if (bool_) { return on_true_(ASIO_MOVE_CAST(Args)(args)...); } else { return on_false_(ASIO_MOVE_CAST(Args)(args)...); } } #endif // defined(ASIO_HAS_REF_QUALIFIED_FUNCTIONS) /// Set the true branch of the conditional. template deferred_conditional then(T on_true, typename constraint< is_deferred::value >::type* = 0, typename constraint< is_same< typename conditional::type, deferred_noop >::value >::type* = 0) ASIO_RVALUE_REF_QUAL { return deferred_conditional( bool_, ASIO_MOVE_CAST(T)(on_true), ASIO_MOVE_CAST(OnFalse)(on_false_)); } /// Set the false branch of the conditional. template deferred_conditional otherwise(T on_false, typename constraint< is_deferred::value >::type* = 0, typename constraint< !is_same< typename conditional::type, deferred_noop >::value >::type* = 0, typename constraint< is_same< typename conditional::type, deferred_noop >::value >::type* = 0) ASIO_RVALUE_REF_QUAL { return deferred_conditional( bool_, ASIO_MOVE_CAST(OnTrue)(on_true_), ASIO_MOVE_CAST(T)(on_false)); } }; #if !defined(GENERATING_DOCUMENTATION) template struct is_deferred > : true_type { }; #endif // !defined(GENERATING_DOCUMENTATION) /// Class used to specify that an asynchronous operation should return a /// function object to lazily launch the operation. /** * The deferred_t class is used to indicate that an asynchronous operation * should return a function object which is itself an initiation function. A * deferred_t object may be passed as a completion token to an asynchronous * operation, typically using the special value @c asio::deferred. For * example: * * @code auto my_deferred_op * = my_socket.async_read_some(my_buffer, * asio::deferred); @endcode * * The initiating function (async_read_some in the above example) returns a * function object that will lazily initiate the operation. */ class deferred_t { public: /// Default constructor. ASIO_CONSTEXPR deferred_t() { } /// Adapts an executor to add the @c deferred_t completion token as the /// default. template struct executor_with_default : InnerExecutor { /// Specify @c deferred_t as the default completion token type. typedef deferred_t default_completion_token_type; /// Construct the adapted executor from the inner executor type. template executor_with_default(const InnerExecutor1& ex, typename constraint< conditional< !is_same::value, is_convertible, false_type >::type::value >::type = 0) ASIO_NOEXCEPT : InnerExecutor(ex) { } }; /// Type alias to adapt an I/O object to use @c deferred_t as its /// default completion token type. #if defined(ASIO_HAS_ALIAS_TEMPLATES) \ || defined(GENERATING_DOCUMENTATION) template using as_default_on_t = typename T::template rebind_executor< executor_with_default >::other; #endif // defined(ASIO_HAS_ALIAS_TEMPLATES) // || defined(GENERATING_DOCUMENTATION) /// Function helper to adapt an I/O object to use @c deferred_t as its /// default completion token type. template static typename decay::type::template rebind_executor< executor_with_default::type::executor_type> >::other as_default_on(ASIO_MOVE_ARG(T) object) { return typename decay::type::template rebind_executor< executor_with_default::type::executor_type> >::other(ASIO_MOVE_CAST(T)(object)); } /// Creates a new deferred from a function. template typename constraint< !is_deferred::type>::value, deferred_function::type> >::type operator()(ASIO_MOVE_ARG(Function) function) const { return deferred_function::type>( deferred_init_tag{}, ASIO_MOVE_CAST(Function)(function)); } /// Passes through anything that is already deferred. template typename constraint< is_deferred::type>::value, typename decay::type >::type operator()(ASIO_MOVE_ARG(T) t) const { return ASIO_MOVE_CAST(T)(t); } /// Returns a deferred operation that returns the provided values. template static ASIO_CONSTEXPR deferred_values::type...> values(ASIO_MOVE_ARG(Args)... args) { return deferred_values::type...>( deferred_init_tag{}, ASIO_MOVE_CAST(Args)(args)...); } /// Creates a conditional object for branching deferred operations. static ASIO_CONSTEXPR deferred_conditional<> when(bool b) { return deferred_conditional<>(b); } }; /// Pipe operator used to chain deferred operations. template inline auto operator|(Head head, ASIO_MOVE_ARG(Tail) tail) -> typename constraint< is_deferred::value, decltype(ASIO_MOVE_OR_LVALUE(Head)(head)( ASIO_MOVE_CAST(Tail)(tail))) >::type { return ASIO_MOVE_OR_LVALUE(Head)(head)( ASIO_MOVE_CAST(Tail)(tail)); } /// A @ref completion_token object used to specify that an asynchronous /// operation should return a function object to lazily launch the operation. /** * See the documentation for asio::deferred_t for a usage example. */ #if defined(ASIO_HAS_CONSTEXPR) || defined(GENERATING_DOCUMENTATION) constexpr deferred_t deferred; #elif defined(ASIO_MSVC) __declspec(selectany) deferred_t deferred; #endif } // namespace asio #include "asio/detail/pop_options.hpp" #include "asio/impl/deferred.hpp" #endif // (defined(ASIO_HAS_STD_TUPLE) // && defined(ASIO_HAS_DECLTYPE)) // && defined(ASIO_HAS_VARIADIC_TEMPLATES)) // || defined(GENERATING_DOCUMENTATION) #endif // ASIO_DEFERRED_HPP