as_single.hpp 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. //
  2. // experimental/as_single.hpp
  3. // ~~~~~~~~~~~~~~~~~~~~~~~~~~
  4. //
  5. // Copyright (c) 2003-2022 Christopher M. Kohlhoff (chris at kohlhoff dot com)
  6. //
  7. // Distributed under the Boost Software License, Version 1.0. (See accompanying
  8. // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  9. //
  10. #ifndef ASIO_EXPERIMENTAL_AS_SINGLE_HPP
  11. #define ASIO_EXPERIMENTAL_AS_SINGLE_HPP
  12. #if defined(_MSC_VER) && (_MSC_VER >= 1200)
  13. # pragma once
  14. #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
  15. #include "asio/detail/config.hpp"
  16. #include "asio/detail/type_traits.hpp"
  17. #include "asio/detail/push_options.hpp"
  18. namespace asio {
  19. namespace experimental {
  20. /// Completion token type used to specify that the completion handler
  21. /// arguments should be combined into a single argument.
  22. /**
  23. * The as_single_t class is used to indicate that any arguments to the
  24. * completion handler should be combined and passed as a single argument.
  25. * If there is already one argument, that argument is passed as-is. If
  26. * there is more than argument, the arguments are first moved into a
  27. * @c std::tuple and that tuple is then passed to the completion handler.
  28. */
  29. template <typename CompletionToken>
  30. class as_single_t
  31. {
  32. public:
  33. /// Tag type used to prevent the "default" constructor from being used for
  34. /// conversions.
  35. struct default_constructor_tag {};
  36. /// Default constructor.
  37. /**
  38. * This constructor is only valid if the underlying completion token is
  39. * default constructible and move constructible. The underlying completion
  40. * token is itself defaulted as an argument to allow it to capture a source
  41. * location.
  42. */
  43. ASIO_CONSTEXPR as_single_t(
  44. default_constructor_tag = default_constructor_tag(),
  45. CompletionToken token = CompletionToken())
  46. : token_(ASIO_MOVE_CAST(CompletionToken)(token))
  47. {
  48. }
  49. /// Constructor.
  50. template <typename T>
  51. ASIO_CONSTEXPR explicit as_single_t(
  52. ASIO_MOVE_ARG(T) completion_token)
  53. : token_(ASIO_MOVE_CAST(T)(completion_token))
  54. {
  55. }
  56. /// Adapts an executor to add the @c as_single_t completion token as the
  57. /// default.
  58. template <typename InnerExecutor>
  59. struct executor_with_default : InnerExecutor
  60. {
  61. /// Specify @c as_single_t as the default completion token type.
  62. typedef as_single_t default_completion_token_type;
  63. /// Construct the adapted executor from the inner executor type.
  64. executor_with_default(const InnerExecutor& ex) ASIO_NOEXCEPT
  65. : InnerExecutor(ex)
  66. {
  67. }
  68. /// Convert the specified executor to the inner executor type, then use
  69. /// that to construct the adapted executor.
  70. template <typename OtherExecutor>
  71. executor_with_default(const OtherExecutor& ex,
  72. typename constraint<
  73. is_convertible<OtherExecutor, InnerExecutor>::value
  74. >::type = 0) ASIO_NOEXCEPT
  75. : InnerExecutor(ex)
  76. {
  77. }
  78. };
  79. /// Type alias to adapt an I/O object to use @c as_single_t as its
  80. /// default completion token type.
  81. #if defined(ASIO_HAS_ALIAS_TEMPLATES) \
  82. || defined(GENERATING_DOCUMENTATION)
  83. template <typename T>
  84. using as_default_on_t = typename T::template rebind_executor<
  85. executor_with_default<typename T::executor_type> >::other;
  86. #endif // defined(ASIO_HAS_ALIAS_TEMPLATES)
  87. // || defined(GENERATING_DOCUMENTATION)
  88. /// Function helper to adapt an I/O object to use @c as_single_t as its
  89. /// default completion token type.
  90. template <typename T>
  91. static typename decay<T>::type::template rebind_executor<
  92. executor_with_default<typename decay<T>::type::executor_type>
  93. >::other
  94. as_default_on(ASIO_MOVE_ARG(T) object)
  95. {
  96. return typename decay<T>::type::template rebind_executor<
  97. executor_with_default<typename decay<T>::type::executor_type>
  98. >::other(ASIO_MOVE_CAST(T)(object));
  99. }
  100. //private:
  101. CompletionToken token_;
  102. };
  103. /// Create a completion token to specify that the completion handler arguments
  104. /// should be combined into a single argument.
  105. template <typename CompletionToken>
  106. ASIO_NODISCARD inline
  107. ASIO_CONSTEXPR as_single_t<typename decay<CompletionToken>::type>
  108. as_single(ASIO_MOVE_ARG(CompletionToken) completion_token)
  109. {
  110. return as_single_t<typename decay<CompletionToken>::type>(
  111. ASIO_MOVE_CAST(CompletionToken)(completion_token));
  112. }
  113. } // namespace experimental
  114. } // namespace asio
  115. #include "asio/detail/pop_options.hpp"
  116. #include "asio/experimental/impl/as_single.hpp"
  117. #endif // ASIO_EXPERIMENTAL_AS_SINGLE_HPP