consign.hpp 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. //
  2. // consign.hpp
  3. // ~~~~~~~~~~
  4. //
  5. // Copyright (c) 2003-2023 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 BOOST_ASIO_CONSIGN_HPP
  11. #define BOOST_ASIO_CONSIGN_HPP
  12. #if defined(_MSC_VER) && (_MSC_VER >= 1200)
  13. # pragma once
  14. #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
  15. #include <boost/asio/detail/config.hpp>
  16. #if (defined(BOOST_ASIO_HAS_STD_TUPLE) \
  17. && defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)) \
  18. || defined(GENERATING_DOCUMENTATION)
  19. #include <tuple>
  20. #include <boost/asio/detail/type_traits.hpp>
  21. #include <boost/asio/detail/push_options.hpp>
  22. namespace boost {
  23. namespace asio {
  24. /// Completion token type used to specify that the completion handler should
  25. /// carry additional values along with it.
  26. /**
  27. * This completion token adapter is typically used to keep at least one copy of
  28. * an object, such as a smart pointer, alive until the completion handler is
  29. * called.
  30. */
  31. template <typename CompletionToken, typename... Values>
  32. class consign_t
  33. {
  34. public:
  35. /// Constructor.
  36. template <typename T, typename... V>
  37. BOOST_ASIO_CONSTEXPR explicit consign_t(
  38. BOOST_ASIO_MOVE_ARG(T) completion_token,
  39. BOOST_ASIO_MOVE_ARG(V)... values)
  40. : token_(BOOST_ASIO_MOVE_CAST(T)(completion_token)),
  41. values_(BOOST_ASIO_MOVE_CAST(V)(values)...)
  42. {
  43. }
  44. #if defined(GENERATING_DOCUMENTATION)
  45. private:
  46. #endif // defined(GENERATING_DOCUMENTATION)
  47. CompletionToken token_;
  48. std::tuple<Values...> values_;
  49. };
  50. /// Completion token adapter used to specify that the completion handler should
  51. /// carry additional values along with it.
  52. /**
  53. * This completion token adapter is typically used to keep at least one copy of
  54. * an object, such as a smart pointer, alive until the completion handler is
  55. * called.
  56. */
  57. template <typename CompletionToken, typename... Values>
  58. BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONSTEXPR consign_t<
  59. typename decay<CompletionToken>::type, typename decay<Values>::type...>
  60. consign(BOOST_ASIO_MOVE_ARG(CompletionToken) completion_token,
  61. BOOST_ASIO_MOVE_ARG(Values)... values)
  62. {
  63. return consign_t<
  64. typename decay<CompletionToken>::type, typename decay<Values>::type...>(
  65. BOOST_ASIO_MOVE_CAST(CompletionToken)(completion_token),
  66. BOOST_ASIO_MOVE_CAST(Values)(values)...);
  67. }
  68. } // namespace asio
  69. } // namespace boost
  70. #include <boost/asio/detail/pop_options.hpp>
  71. #include <boost/asio/impl/consign.hpp>
  72. #endif // (defined(BOOST_ASIO_HAS_STD_TUPLE)
  73. // && defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES))
  74. // || defined(GENERATING_DOCUMENTATION)
  75. #endif // BOOST_ASIO_CONSIGN_HPP