async_result.hpp 41 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273
  1. //
  2. // async_result.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 BOOST_ASIO_ASYNC_RESULT_HPP
  11. #define BOOST_ASIO_ASYNC_RESULT_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. #include <boost/asio/detail/type_traits.hpp>
  17. #include <boost/asio/detail/variadic_templates.hpp>
  18. #include <boost/asio/detail/push_options.hpp>
  19. namespace boost {
  20. namespace asio {
  21. #if defined(BOOST_ASIO_HAS_CONCEPTS) \
  22. && defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES) \
  23. && defined(BOOST_ASIO_HAS_DECLTYPE)
  24. namespace detail {
  25. template <typename T>
  26. struct is_completion_signature : false_type
  27. {
  28. };
  29. template <typename R, typename... Args>
  30. struct is_completion_signature<R(Args...)> : true_type
  31. {
  32. };
  33. #if defined(BOOST_ASIO_HAS_REF_QUALIFIED_FUNCTIONS)
  34. template <typename R, typename... Args>
  35. struct is_completion_signature<R(Args...) &> : true_type
  36. {
  37. };
  38. template <typename R, typename... Args>
  39. struct is_completion_signature<R(Args...) &&> : true_type
  40. {
  41. };
  42. # if defined(BOOST_ASIO_HAS_NOEXCEPT_FUNCTION_TYPE)
  43. template <typename R, typename... Args>
  44. struct is_completion_signature<R(Args...) noexcept> : true_type
  45. {
  46. };
  47. template <typename R, typename... Args>
  48. struct is_completion_signature<R(Args...) & noexcept> : true_type
  49. {
  50. };
  51. template <typename R, typename... Args>
  52. struct is_completion_signature<R(Args...) && noexcept> : true_type
  53. {
  54. };
  55. # endif // defined(BOOST_ASIO_HAS_NOEXCEPT_FUNCTION_TYPE)
  56. #endif // defined(BOOST_ASIO_HAS_REF_QUALIFIED_FUNCTIONS)
  57. template <typename... T>
  58. struct are_completion_signatures : false_type
  59. {
  60. };
  61. template <typename T0>
  62. struct are_completion_signatures<T0>
  63. : is_completion_signature<T0>
  64. {
  65. };
  66. template <typename T0, typename... TN>
  67. struct are_completion_signatures<T0, TN...>
  68. : integral_constant<bool, (
  69. is_completion_signature<T0>::value
  70. && are_completion_signatures<TN...>::value)>
  71. {
  72. };
  73. template <typename T, typename... Args>
  74. BOOST_ASIO_CONCEPT callable_with = requires(T&& t, Args&&... args)
  75. {
  76. static_cast<T&&>(t)(static_cast<Args&&>(args)...);
  77. };
  78. template <typename T, typename... Signatures>
  79. struct is_completion_handler_for : false_type
  80. {
  81. };
  82. template <typename T, typename R, typename... Args>
  83. struct is_completion_handler_for<T, R(Args...)>
  84. : integral_constant<bool, (callable_with<T, Args...>)>
  85. {
  86. };
  87. #if defined(BOOST_ASIO_HAS_REF_QUALIFIED_FUNCTIONS)
  88. template <typename T, typename R, typename... Args>
  89. struct is_completion_handler_for<T, R(Args...) &>
  90. : integral_constant<bool, (callable_with<T&, Args...>)>
  91. {
  92. };
  93. template <typename T, typename R, typename... Args>
  94. struct is_completion_handler_for<T, R(Args...) &&>
  95. : integral_constant<bool, (callable_with<T&&, Args...>)>
  96. {
  97. };
  98. # if defined(BOOST_ASIO_HAS_NOEXCEPT_FUNCTION_TYPE)
  99. template <typename T, typename R, typename... Args>
  100. struct is_completion_handler_for<T, R(Args...) noexcept>
  101. : integral_constant<bool, (callable_with<T, Args...>)>
  102. {
  103. };
  104. template <typename T, typename R, typename... Args>
  105. struct is_completion_handler_for<T, R(Args...) & noexcept>
  106. : integral_constant<bool, (callable_with<T&, Args...>)>
  107. {
  108. };
  109. template <typename T, typename R, typename... Args>
  110. struct is_completion_handler_for<T, R(Args...) && noexcept>
  111. : integral_constant<bool, (callable_with<T&&, Args...>)>
  112. {
  113. };
  114. # endif // defined(BOOST_ASIO_HAS_NOEXCEPT_FUNCTION_TYPE)
  115. #endif // defined(BOOST_ASIO_HAS_REF_QUALIFIED_FUNCTIONS)
  116. template <typename T, typename Signature0, typename... SignatureN>
  117. struct is_completion_handler_for<T, Signature0, SignatureN...>
  118. : integral_constant<bool, (
  119. is_completion_handler_for<T, Signature0>::value
  120. && is_completion_handler_for<T, SignatureN...>::value)>
  121. {
  122. };
  123. } // namespace detail
  124. template <typename T>
  125. BOOST_ASIO_CONCEPT completion_signature =
  126. detail::is_completion_signature<T>::value;
  127. #define BOOST_ASIO_COMPLETION_SIGNATURE \
  128. ::boost::asio::completion_signature
  129. template <typename T, typename... Signatures>
  130. BOOST_ASIO_CONCEPT completion_handler_for =
  131. detail::are_completion_signatures<Signatures...>::value
  132. && detail::is_completion_handler_for<T, Signatures...>::value;
  133. #define BOOST_ASIO_COMPLETION_HANDLER_FOR(sig) \
  134. ::boost::asio::completion_handler_for<sig>
  135. #define BOOST_ASIO_COMPLETION_HANDLER_FOR2(sig0, sig1) \
  136. ::boost::asio::completion_handler_for<sig0, sig1>
  137. #define BOOST_ASIO_COMPLETION_HANDLER_FOR3(sig0, sig1, sig2) \
  138. ::boost::asio::completion_handler_for<sig0, sig1, sig2>
  139. #else // defined(BOOST_ASIO_HAS_CONCEPTS)
  140. // && defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  141. // && defined(BOOST_ASIO_HAS_DECLTYPE)
  142. #define BOOST_ASIO_COMPLETION_SIGNATURE typename
  143. #define BOOST_ASIO_COMPLETION_HANDLER_FOR(sig) typename
  144. #define BOOST_ASIO_COMPLETION_HANDLER_FOR2(sig0, sig1) typename
  145. #define BOOST_ASIO_COMPLETION_HANDLER_FOR3(sig0, sig1, sig2) typename
  146. #endif // defined(BOOST_ASIO_HAS_CONCEPTS)
  147. // && defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  148. // && defined(BOOST_ASIO_HAS_DECLTYPE)
  149. namespace detail {
  150. template <typename T>
  151. struct is_simple_completion_signature : false_type
  152. {
  153. };
  154. template <typename T>
  155. struct simple_completion_signature;
  156. #if defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  157. template <typename R, typename... Args>
  158. struct is_simple_completion_signature<R(Args...)> : true_type
  159. {
  160. };
  161. template <typename... Signatures>
  162. struct are_simple_completion_signatures : false_type
  163. {
  164. };
  165. template <typename Sig0>
  166. struct are_simple_completion_signatures<Sig0>
  167. : is_simple_completion_signature<Sig0>
  168. {
  169. };
  170. template <typename Sig0, typename... SigN>
  171. struct are_simple_completion_signatures<Sig0, SigN...>
  172. : integral_constant<bool, (
  173. is_simple_completion_signature<Sig0>::value
  174. && are_simple_completion_signatures<SigN...>::value)>
  175. {
  176. };
  177. template <typename R, typename... Args>
  178. struct simple_completion_signature<R(Args...)>
  179. {
  180. typedef R type(Args...);
  181. };
  182. #if defined(BOOST_ASIO_HAS_REF_QUALIFIED_FUNCTIONS)
  183. template <typename R, typename... Args>
  184. struct simple_completion_signature<R(Args...) &>
  185. {
  186. typedef R type(Args...);
  187. };
  188. template <typename R, typename... Args>
  189. struct simple_completion_signature<R(Args...) &&>
  190. {
  191. typedef R type(Args...);
  192. };
  193. # if defined(BOOST_ASIO_HAS_NOEXCEPT_FUNCTION_TYPE)
  194. template <typename R, typename... Args>
  195. struct simple_completion_signature<R(Args...) noexcept>
  196. {
  197. typedef R type(Args...);
  198. };
  199. template <typename R, typename... Args>
  200. struct simple_completion_signature<R(Args...) & noexcept>
  201. {
  202. typedef R type(Args...);
  203. };
  204. template <typename R, typename... Args>
  205. struct simple_completion_signature<R(Args...) && noexcept>
  206. {
  207. typedef R type(Args...);
  208. };
  209. # endif // defined(BOOST_ASIO_HAS_NOEXCEPT_FUNCTION_TYPE)
  210. #endif // defined(BOOST_ASIO_HAS_REF_QUALIFIED_FUNCTIONS)
  211. #else // defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  212. template <typename R>
  213. struct is_simple_completion_signature<R()> : true_type
  214. {
  215. };
  216. #define BOOST_ASIO_PRIVATE_SIMPLE_SIG_DEF(n) \
  217. template <typename R, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  218. struct is_simple_completion_signature<R(BOOST_ASIO_VARIADIC_TARGS(n))> \
  219. : true_type \
  220. { \
  221. }; \
  222. /**/
  223. BOOST_ASIO_VARIADIC_GENERATE(BOOST_ASIO_PRIVATE_SIMPLE_SIG_DEF)
  224. #undef BOOST_ASIO_PRIVATE_SIMPLE_SIG_DEF
  225. template <typename Sig0 = void, typename Sig1 = void,
  226. typename Sig2 = void, typename = void>
  227. struct are_simple_completion_signatures : false_type
  228. {
  229. };
  230. template <typename Sig0>
  231. struct are_simple_completion_signatures<Sig0>
  232. : is_simple_completion_signature<Sig0>
  233. {
  234. };
  235. template <typename Sig0, typename Sig1>
  236. struct are_simple_completion_signatures<Sig0, Sig1>
  237. : integral_constant<bool,
  238. (is_simple_completion_signature<Sig0>::value
  239. && is_simple_completion_signature<Sig1>::value)>
  240. {
  241. };
  242. template <typename Sig0, typename Sig1, typename Sig2>
  243. struct are_simple_completion_signatures<Sig0, Sig1, Sig2>
  244. : integral_constant<bool,
  245. (is_simple_completion_signature<Sig0>::value
  246. && is_simple_completion_signature<Sig1>::value
  247. && is_simple_completion_signature<Sig2>::value)>
  248. {
  249. };
  250. template <>
  251. struct simple_completion_signature<void>
  252. {
  253. typedef void type;
  254. };
  255. template <typename R>
  256. struct simple_completion_signature<R()>
  257. {
  258. typedef R type();
  259. };
  260. #define BOOST_ASIO_PRIVATE_SIMPLE_SIG_DEF(n) \
  261. template <typename R, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  262. struct simple_completion_signature<R(BOOST_ASIO_VARIADIC_TARGS(n))> \
  263. { \
  264. typedef R type(BOOST_ASIO_VARIADIC_TARGS(n)); \
  265. }; \
  266. /**/
  267. BOOST_ASIO_VARIADIC_GENERATE(BOOST_ASIO_PRIVATE_SIMPLE_SIG_DEF)
  268. #undef BOOST_ASIO_PRIVATE_SIMPLE_SIG_DEF
  269. #if defined(BOOST_ASIO_HAS_REF_QUALIFIED_FUNCTIONS)
  270. template <typename R>
  271. struct simple_completion_signature<R() &>
  272. {
  273. typedef R type();
  274. };
  275. template <typename R>
  276. struct simple_completion_signature<R() &&>
  277. {
  278. typedef R type();
  279. };
  280. #define BOOST_ASIO_PRIVATE_SIMPLE_SIG_DEF(n) \
  281. template <typename R, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  282. struct simple_completion_signature< \
  283. R(BOOST_ASIO_VARIADIC_TARGS(n)) &> \
  284. { \
  285. typedef R type(BOOST_ASIO_VARIADIC_TARGS(n)); \
  286. }; \
  287. \
  288. template <typename R, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  289. struct simple_completion_signature< \
  290. R(BOOST_ASIO_VARIADIC_TARGS(n)) &&> \
  291. { \
  292. typedef R type(BOOST_ASIO_VARIADIC_TARGS(n)); \
  293. }; \
  294. /**/
  295. BOOST_ASIO_VARIADIC_GENERATE(BOOST_ASIO_PRIVATE_SIMPLE_SIG_DEF)
  296. #undef BOOST_ASIO_PRIVATE_SIMPLE_SIG_DEF
  297. # if defined(BOOST_ASIO_HAS_NOEXCEPT_FUNCTION_TYPE)
  298. template <typename R>
  299. struct simple_completion_signature<R() noexcept>
  300. {
  301. typedef R type();
  302. };
  303. template <typename R>
  304. struct simple_completion_signature<R() & noexcept>
  305. {
  306. typedef R type();
  307. };
  308. template <typename R>
  309. struct simple_completion_signature<R() && noexcept>
  310. {
  311. typedef R type();
  312. };
  313. #define BOOST_ASIO_PRIVATE_SIMPLE_SIG_DEF(n) \
  314. template <typename R, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  315. struct simple_completion_signature< \
  316. R(BOOST_ASIO_VARIADIC_TARGS(n)) noexcept> \
  317. { \
  318. typedef R type(BOOST_ASIO_VARIADIC_TARGS(n)); \
  319. }; \
  320. \
  321. template <typename R, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  322. struct simple_completion_signature< \
  323. R(BOOST_ASIO_VARIADIC_TARGS(n)) & noexcept> \
  324. { \
  325. typedef R type(BOOST_ASIO_VARIADIC_TARGS(n)); \
  326. }; \
  327. \
  328. template <typename R, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  329. struct simple_completion_signature< \
  330. R(BOOST_ASIO_VARIADIC_TARGS(n)) && noexcept> \
  331. { \
  332. typedef R type(BOOST_ASIO_VARIADIC_TARGS(n)); \
  333. }; \
  334. /**/
  335. BOOST_ASIO_VARIADIC_GENERATE(BOOST_ASIO_PRIVATE_SIMPLE_SIG_DEF)
  336. #undef BOOST_ASIO_PRIVATE_SIMPLE_SIG_DEF
  337. # endif // defined(BOOST_ASIO_HAS_NOEXCEPT_FUNCTION_TYPE)
  338. #endif // defined(BOOST_ASIO_HAS_REF_QUALIFIED_FUNCTIONS)
  339. #endif // defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  340. #if defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES) \
  341. || defined(GENERATING_DOCUMENTATION)
  342. # define BOOST_ASIO_COMPLETION_SIGNATURES_TPARAMS \
  343. BOOST_ASIO_COMPLETION_SIGNATURE... Signatures
  344. # define BOOST_ASIO_COMPLETION_SIGNATURES_TSPECPARAMS \
  345. BOOST_ASIO_COMPLETION_SIGNATURE... Signatures
  346. # define BOOST_ASIO_COMPLETION_SIGNATURES_TARGS Signatures...
  347. # define BOOST_ASIO_COMPLETION_SIGNATURES_TSIMPLEARGS \
  348. typename boost::asio::detail::simple_completion_signature< \
  349. Signatures>::type...
  350. #else // defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  351. // || defined(GENERATING_DOCUMENTATION)
  352. # define BOOST_ASIO_COMPLETION_SIGNATURES_TPARAMS \
  353. typename Sig0 = void, \
  354. typename Sig1 = void, \
  355. typename Sig2 = void
  356. # define BOOST_ASIO_COMPLETION_SIGNATURES_TSPECPARAMS \
  357. typename Sig0, \
  358. typename Sig1, \
  359. typename Sig2
  360. # define BOOST_ASIO_COMPLETION_SIGNATURES_TARGS Sig0, Sig1, Sig2
  361. # define BOOST_ASIO_COMPLETION_SIGNATURES_TSIMPLEARGS \
  362. typename ::boost::asio::detail::simple_completion_signature<Sig0>::type, \
  363. typename ::boost::asio::detail::simple_completion_signature<Sig1>::type, \
  364. typename ::boost::asio::detail::simple_completion_signature<Sig2>::type
  365. #endif // defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  366. // || defined(GENERATING_DOCUMENTATION)
  367. template <typename CompletionToken, BOOST_ASIO_COMPLETION_SIGNATURES_TPARAMS>
  368. class completion_handler_async_result
  369. {
  370. public:
  371. typedef CompletionToken completion_handler_type;
  372. typedef void return_type;
  373. explicit completion_handler_async_result(completion_handler_type&)
  374. {
  375. }
  376. return_type get()
  377. {
  378. }
  379. #if defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  380. template <typename Initiation,
  381. BOOST_ASIO_COMPLETION_HANDLER_FOR(Signatures...) RawCompletionToken,
  382. typename... Args>
  383. static return_type initiate(
  384. BOOST_ASIO_MOVE_ARG(Initiation) initiation,
  385. BOOST_ASIO_MOVE_ARG(RawCompletionToken) token,
  386. BOOST_ASIO_MOVE_ARG(Args)... args)
  387. {
  388. BOOST_ASIO_MOVE_CAST(Initiation)(initiation)(
  389. BOOST_ASIO_MOVE_CAST(RawCompletionToken)(token),
  390. BOOST_ASIO_MOVE_CAST(Args)(args)...);
  391. }
  392. #else // defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  393. template <typename Initiation, typename RawCompletionToken>
  394. static return_type initiate(
  395. BOOST_ASIO_MOVE_ARG(Initiation) initiation,
  396. BOOST_ASIO_MOVE_ARG(RawCompletionToken) token)
  397. {
  398. BOOST_ASIO_MOVE_CAST(Initiation)(initiation)(
  399. BOOST_ASIO_MOVE_CAST(RawCompletionToken)(token));
  400. }
  401. #define BOOST_ASIO_PRIVATE_INITIATE_DEF(n) \
  402. template <typename Initiation, \
  403. typename RawCompletionToken, \
  404. BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  405. static return_type initiate( \
  406. BOOST_ASIO_MOVE_ARG(Initiation) initiation, \
  407. BOOST_ASIO_MOVE_ARG(RawCompletionToken) token, \
  408. BOOST_ASIO_VARIADIC_MOVE_PARAMS(n)) \
  409. { \
  410. BOOST_ASIO_MOVE_CAST(Initiation)(initiation)( \
  411. BOOST_ASIO_MOVE_CAST(RawCompletionToken)(token), \
  412. BOOST_ASIO_VARIADIC_MOVE_ARGS(n)); \
  413. } \
  414. /**/
  415. BOOST_ASIO_VARIADIC_GENERATE(BOOST_ASIO_PRIVATE_INITIATE_DEF)
  416. #undef BOOST_ASIO_PRIVATE_INITIATE_DEF
  417. #endif // defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  418. private:
  419. completion_handler_async_result(
  420. const completion_handler_async_result&) BOOST_ASIO_DELETED;
  421. completion_handler_async_result& operator=(
  422. const completion_handler_async_result&) BOOST_ASIO_DELETED;
  423. };
  424. } // namespace detail
  425. #if defined(GENERATING_DOCUMENTATION)
  426. /// An interface for customising the behaviour of an initiating function.
  427. /**
  428. * The async_result traits class is used for determining:
  429. *
  430. * @li the concrete completion handler type to be called at the end of the
  431. * asynchronous operation;
  432. *
  433. * @li the initiating function return type; and
  434. *
  435. * @li how the return value of the initiating function is obtained.
  436. *
  437. * The trait allows the handler and return types to be determined at the point
  438. * where the specific completion handler signature is known.
  439. *
  440. * This template may be specialised for user-defined completion token types.
  441. * The primary template assumes that the CompletionToken is the completion
  442. * handler.
  443. */
  444. template <typename CompletionToken, BOOST_ASIO_COMPLETION_SIGNATURES_TPARAMS>
  445. class async_result
  446. {
  447. public:
  448. /// The concrete completion handler type for the specific signature.
  449. typedef CompletionToken completion_handler_type;
  450. /// The return type of the initiating function.
  451. typedef void return_type;
  452. /// Construct an async result from a given handler.
  453. /**
  454. * When using a specalised async_result, the constructor has an opportunity
  455. * to initialise some state associated with the completion handler, which is
  456. * then returned from the initiating function.
  457. */
  458. explicit async_result(completion_handler_type& h);
  459. /// Obtain the value to be returned from the initiating function.
  460. return_type get();
  461. /// Initiate the asynchronous operation that will produce the result, and
  462. /// obtain the value to be returned from the initiating function.
  463. template <typename Initiation, typename RawCompletionToken, typename... Args>
  464. static return_type initiate(
  465. BOOST_ASIO_MOVE_ARG(Initiation) initiation,
  466. BOOST_ASIO_MOVE_ARG(RawCompletionToken) token,
  467. BOOST_ASIO_MOVE_ARG(Args)... args);
  468. private:
  469. async_result(const async_result&) BOOST_ASIO_DELETED;
  470. async_result& operator=(const async_result&) BOOST_ASIO_DELETED;
  471. };
  472. #else // defined(GENERATING_DOCUMENTATION)
  473. #if defined(BOOST_ASIO_HAS_REF_QUALIFIED_FUNCTIONS)
  474. template <typename CompletionToken, BOOST_ASIO_COMPLETION_SIGNATURES_TPARAMS>
  475. class async_result :
  476. public conditional<
  477. detail::are_simple_completion_signatures<
  478. BOOST_ASIO_COMPLETION_SIGNATURES_TARGS>::value,
  479. detail::completion_handler_async_result<
  480. CompletionToken, BOOST_ASIO_COMPLETION_SIGNATURES_TARGS>,
  481. async_result<CompletionToken,
  482. BOOST_ASIO_COMPLETION_SIGNATURES_TSIMPLEARGS>
  483. >::type
  484. {
  485. public:
  486. typedef typename conditional<
  487. detail::are_simple_completion_signatures<
  488. BOOST_ASIO_COMPLETION_SIGNATURES_TARGS>::value,
  489. detail::completion_handler_async_result<
  490. CompletionToken, BOOST_ASIO_COMPLETION_SIGNATURES_TARGS>,
  491. async_result<CompletionToken,
  492. BOOST_ASIO_COMPLETION_SIGNATURES_TSIMPLEARGS>
  493. >::type base_type;
  494. using base_type::base_type;
  495. private:
  496. async_result(const async_result&) BOOST_ASIO_DELETED;
  497. async_result& operator=(const async_result&) BOOST_ASIO_DELETED;
  498. };
  499. #else // defined(BOOST_ASIO_HAS_REF_QUALIFIED_FUNCTIONS)
  500. template <typename CompletionToken, BOOST_ASIO_COMPLETION_SIGNATURES_TPARAMS>
  501. class async_result :
  502. public detail::completion_handler_async_result<
  503. CompletionToken, BOOST_ASIO_COMPLETION_SIGNATURES_TARGS>
  504. {
  505. public:
  506. explicit async_result(CompletionToken& h)
  507. : detail::completion_handler_async_result<
  508. CompletionToken, BOOST_ASIO_COMPLETION_SIGNATURES_TARGS>(h)
  509. {
  510. }
  511. private:
  512. async_result(const async_result&) BOOST_ASIO_DELETED;
  513. async_result& operator=(const async_result&) BOOST_ASIO_DELETED;
  514. };
  515. #endif // defined(BOOST_ASIO_HAS_REF_QUALIFIED_FUNCTIONS)
  516. template <BOOST_ASIO_COMPLETION_SIGNATURES_TSPECPARAMS>
  517. class async_result<void, BOOST_ASIO_COMPLETION_SIGNATURES_TARGS>
  518. {
  519. // Empty.
  520. };
  521. #endif // defined(GENERATING_DOCUMENTATION)
  522. /// Helper template to deduce the handler type from a CompletionToken, capture
  523. /// a local copy of the handler, and then create an async_result for the
  524. /// handler.
  525. template <typename CompletionToken, BOOST_ASIO_COMPLETION_SIGNATURES_TPARAMS>
  526. struct async_completion
  527. {
  528. /// The real handler type to be used for the asynchronous operation.
  529. typedef typename boost::asio::async_result<
  530. typename decay<CompletionToken>::type,
  531. BOOST_ASIO_COMPLETION_SIGNATURES_TARGS>::completion_handler_type
  532. completion_handler_type;
  533. #if defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
  534. /// Constructor.
  535. /**
  536. * The constructor creates the concrete completion handler and makes the link
  537. * between the handler and the asynchronous result.
  538. */
  539. explicit async_completion(CompletionToken& token)
  540. : completion_handler(static_cast<typename conditional<
  541. is_same<CompletionToken, completion_handler_type>::value,
  542. completion_handler_type&, CompletionToken&&>::type>(token)),
  543. result(completion_handler)
  544. {
  545. }
  546. #else // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
  547. explicit async_completion(typename decay<CompletionToken>::type& token)
  548. : completion_handler(token),
  549. result(completion_handler)
  550. {
  551. }
  552. explicit async_completion(const typename decay<CompletionToken>::type& token)
  553. : completion_handler(token),
  554. result(completion_handler)
  555. {
  556. }
  557. #endif // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
  558. /// A copy of, or reference to, a real handler object.
  559. #if defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
  560. typename conditional<
  561. is_same<CompletionToken, completion_handler_type>::value,
  562. completion_handler_type&, completion_handler_type>::type completion_handler;
  563. #else // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
  564. completion_handler_type completion_handler;
  565. #endif // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
  566. /// The result of the asynchronous operation's initiating function.
  567. async_result<typename decay<CompletionToken>::type,
  568. BOOST_ASIO_COMPLETION_SIGNATURES_TARGS> result;
  569. };
  570. namespace detail {
  571. template <typename CompletionToken, BOOST_ASIO_COMPLETION_SIGNATURES_TPARAMS>
  572. struct async_result_helper
  573. : async_result<typename decay<CompletionToken>::type,
  574. BOOST_ASIO_COMPLETION_SIGNATURES_TARGS>
  575. {
  576. };
  577. struct async_result_memfns_base
  578. {
  579. void initiate();
  580. };
  581. template <typename T>
  582. struct async_result_memfns_derived
  583. : T, async_result_memfns_base
  584. {
  585. };
  586. template <typename T, T>
  587. struct async_result_memfns_check
  588. {
  589. };
  590. template <typename>
  591. char (&async_result_initiate_memfn_helper(...))[2];
  592. template <typename T>
  593. char async_result_initiate_memfn_helper(
  594. async_result_memfns_check<
  595. void (async_result_memfns_base::*)(),
  596. &async_result_memfns_derived<T>::initiate>*);
  597. template <typename CompletionToken, BOOST_ASIO_COMPLETION_SIGNATURES_TPARAMS>
  598. struct async_result_has_initiate_memfn
  599. : integral_constant<bool, sizeof(async_result_initiate_memfn_helper<
  600. async_result<typename decay<CompletionToken>::type,
  601. BOOST_ASIO_COMPLETION_SIGNATURES_TARGS>
  602. >(0)) != 1>
  603. {
  604. };
  605. } // namespace detail
  606. #if defined(GENERATING_DOCUMENTATION)
  607. # define BOOST_ASIO_INITFN_RESULT_TYPE(ct, sig) \
  608. void_or_deduced
  609. # define BOOST_ASIO_INITFN_RESULT_TYPE2(ct, sig0, sig1) \
  610. void_or_deduced
  611. # define BOOST_ASIO_INITFN_RESULT_TYPE3(ct, sig0, sig1, sig2) \
  612. void_or_deduced
  613. #elif defined(_MSC_VER) && (_MSC_VER < 1500)
  614. # define BOOST_ASIO_INITFN_RESULT_TYPE(ct, sig) \
  615. typename ::boost::asio::detail::async_result_helper< \
  616. ct, sig>::return_type
  617. # define BOOST_ASIO_INITFN_RESULT_TYPE2(ct, sig0, sig1) \
  618. typename ::boost::asio::detail::async_result_helper< \
  619. ct, sig0, sig1>::return_type
  620. # define BOOST_ASIO_INITFN_RESULT_TYPE3(ct, sig0, sig1, sig2) \
  621. typename ::boost::asio::detail::async_result_helper< \
  622. ct, sig0, sig1, sig2>::return_type
  623. #define BOOST_ASIO_HANDLER_TYPE(ct, sig) \
  624. typename ::boost::asio::detail::async_result_helper< \
  625. ct, sig>::completion_handler_type
  626. #define BOOST_ASIO_HANDLER_TYPE2(ct, sig0, sig1) \
  627. typename ::boost::asio::detail::async_result_helper< \
  628. ct, sig0, sig1>::completion_handler_type
  629. #define BOOST_ASIO_HANDLER_TYPE3(ct, sig0, sig1, sig2) \
  630. typename ::boost::asio::detail::async_result_helper< \
  631. ct, sig0, sig1, sig2>::completion_handler_type
  632. #else
  633. # define BOOST_ASIO_INITFN_RESULT_TYPE(ct, sig) \
  634. typename ::boost::asio::async_result< \
  635. typename ::boost::asio::decay<ct>::type, sig>::return_type
  636. # define BOOST_ASIO_INITFN_RESULT_TYPE2(ct, sig0, sig1) \
  637. typename ::boost::asio::async_result< \
  638. typename ::boost::asio::decay<ct>::type, sig0, sig1>::return_type
  639. # define BOOST_ASIO_INITFN_RESULT_TYPE3(ct, sig0, sig1, sig2) \
  640. typename ::boost::asio::async_result< \
  641. typename ::boost::asio::decay<ct>::type, sig0, sig1, sig2>::return_type
  642. #define BOOST_ASIO_HANDLER_TYPE(ct, sig) \
  643. typename ::boost::asio::async_result< \
  644. typename ::boost::asio::decay<ct>::type, sig>::completion_handler_type
  645. #define BOOST_ASIO_HANDLER_TYPE2(ct, sig0, sig1) \
  646. typename ::boost::asio::async_result< \
  647. typename ::boost::asio::decay<ct>::type, \
  648. sig0, sig1>::completion_handler_type
  649. #define BOOST_ASIO_HANDLER_TYPE3(ct, sig0, sig1, sig2) \
  650. typename ::boost::asio::async_result< \
  651. typename ::boost::asio::decay<ct>::type, \
  652. sig0, sig1, sig2>::completion_handler_type
  653. #endif
  654. #if defined(GENERATING_DOCUMENTATION)
  655. # define BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(ct, sig) \
  656. auto
  657. # define BOOST_ASIO_INITFN_AUTO_RESULT_TYPE2(ct, sig0, sig1) \
  658. auto
  659. # define BOOST_ASIO_INITFN_AUTO_RESULT_TYPE3(ct, sig0, sig1, sig2) \
  660. auto
  661. #elif defined(BOOST_ASIO_HAS_RETURN_TYPE_DEDUCTION)
  662. # define BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(ct, sig) \
  663. auto
  664. # define BOOST_ASIO_INITFN_AUTO_RESULT_TYPE2(ct, sig0, sig1) \
  665. auto
  666. # define BOOST_ASIO_INITFN_AUTO_RESULT_TYPE3(ct, sig0, sig1, sig2) \
  667. auto
  668. #else
  669. # define BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(ct, sig) \
  670. BOOST_ASIO_INITFN_RESULT_TYPE(ct, sig)
  671. # define BOOST_ASIO_INITFN_AUTO_RESULT_TYPE2(ct, sig0, sig1) \
  672. BOOST_ASIO_INITFN_RESULT_TYPE2(ct, sig0, sig1)
  673. # define BOOST_ASIO_INITFN_AUTO_RESULT_TYPE3(ct, sig0, sig1, sig2) \
  674. BOOST_ASIO_INITFN_RESULT_TYPE3(ct, sig0, sig1, sig2)
  675. #endif
  676. #if defined(GENERATING_DOCUMENTATION)
  677. # define BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE(ct, sig, expr) \
  678. void_or_deduced
  679. # define BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE2(ct, sig0, sig1, expr) \
  680. void_or_deduced
  681. # define BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE3(ct, sig0, sig1, sig2, expr) \
  682. void_or_deduced
  683. #elif defined(BOOST_ASIO_HAS_DECLTYPE)
  684. # define BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE(ct, sig, expr) \
  685. decltype expr
  686. # define BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE2(ct, sig0, sig1, expr) \
  687. decltype expr
  688. # define BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE3(ct, sig0, sig1, sig2, expr) \
  689. decltype expr
  690. #else
  691. # define BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE(ct, sig, expr) \
  692. BOOST_ASIO_INITFN_RESULT_TYPE(ct, sig)
  693. # define BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE2(ct, sig0, sig1, expr) \
  694. BOOST_ASIO_INITFN_RESULT_TYPE2(ct, sig0, sig1)
  695. # define BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE3(ct, sig0, sig1, sig2, expr) \
  696. BOOST_ASIO_INITFN_RESULT_TYPE3(ct, sig0, sig1, sig2)
  697. #endif
  698. #if defined(GENERATING_DOCUMENTATION)
  699. template <typename CompletionToken,
  700. completion_signature... Signatures,
  701. typename Initiation, typename... Args>
  702. void_or_deduced async_initiate(
  703. BOOST_ASIO_MOVE_ARG(Initiation) initiation,
  704. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken),
  705. BOOST_ASIO_MOVE_ARG(Args)... args);
  706. #elif defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  707. template <typename CompletionToken,
  708. BOOST_ASIO_COMPLETION_SIGNATURE... Signatures,
  709. typename Initiation, typename... Args>
  710. inline typename constraint<
  711. detail::async_result_has_initiate_memfn<
  712. CompletionToken, Signatures...>::value,
  713. BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE(CompletionToken, Signatures...,
  714. (async_result<typename decay<CompletionToken>::type,
  715. Signatures...>::initiate(declval<BOOST_ASIO_MOVE_ARG(Initiation)>(),
  716. declval<BOOST_ASIO_MOVE_ARG(CompletionToken)>(),
  717. declval<BOOST_ASIO_MOVE_ARG(Args)>()...)))>::type
  718. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation,
  719. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token,
  720. BOOST_ASIO_MOVE_ARG(Args)... args)
  721. {
  722. return async_result<typename decay<CompletionToken>::type,
  723. Signatures...>::initiate(BOOST_ASIO_MOVE_CAST(Initiation)(initiation),
  724. BOOST_ASIO_MOVE_CAST(CompletionToken)(token),
  725. BOOST_ASIO_MOVE_CAST(Args)(args)...);
  726. }
  727. template <typename CompletionToken,
  728. BOOST_ASIO_COMPLETION_SIGNATURE... Signatures,
  729. typename Initiation, typename... Args>
  730. inline typename constraint<
  731. !detail::async_result_has_initiate_memfn<
  732. CompletionToken, Signatures...>::value,
  733. BOOST_ASIO_INITFN_RESULT_TYPE(CompletionToken, Signatures...)>::type
  734. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation,
  735. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token,
  736. BOOST_ASIO_MOVE_ARG(Args)... args)
  737. {
  738. async_completion<CompletionToken, Signatures...> completion(token);
  739. BOOST_ASIO_MOVE_CAST(Initiation)(initiation)(
  740. BOOST_ASIO_MOVE_CAST(BOOST_ASIO_HANDLER_TYPE(CompletionToken,
  741. Signatures...))(completion.completion_handler),
  742. BOOST_ASIO_MOVE_CAST(Args)(args)...);
  743. return completion.result.get();
  744. }
  745. #else // defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  746. template <typename CompletionToken,
  747. BOOST_ASIO_COMPLETION_SIGNATURE Sig0,
  748. typename Initiation>
  749. inline typename constraint<
  750. detail::async_result_has_initiate_memfn<
  751. CompletionToken, Sig0>::value,
  752. BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE(CompletionToken, Sig0,
  753. (async_result<typename decay<CompletionToken>::type,
  754. Sig0>::initiate(declval<BOOST_ASIO_MOVE_ARG(Initiation)>(),
  755. declval<BOOST_ASIO_MOVE_ARG(CompletionToken)>())))>::type
  756. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation,
  757. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token)
  758. {
  759. return async_result<typename decay<CompletionToken>::type,
  760. Sig0>::initiate(BOOST_ASIO_MOVE_CAST(Initiation)(initiation),
  761. BOOST_ASIO_MOVE_CAST(CompletionToken)(token));
  762. }
  763. template <typename CompletionToken,
  764. BOOST_ASIO_COMPLETION_SIGNATURE Sig0,
  765. BOOST_ASIO_COMPLETION_SIGNATURE Sig1,
  766. typename Initiation>
  767. inline typename constraint<
  768. detail::async_result_has_initiate_memfn<
  769. CompletionToken, Sig0, Sig1>::value,
  770. BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE2(CompletionToken, Sig0, Sig1,
  771. (async_result<typename decay<CompletionToken>::type,
  772. Sig0, Sig1>::initiate(declval<BOOST_ASIO_MOVE_ARG(Initiation)>(),
  773. declval<BOOST_ASIO_MOVE_ARG(CompletionToken)>())))>::type
  774. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation,
  775. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token)
  776. {
  777. return async_result<typename decay<CompletionToken>::type,
  778. Sig0, Sig1>::initiate(BOOST_ASIO_MOVE_CAST(Initiation)(initiation),
  779. BOOST_ASIO_MOVE_CAST(CompletionToken)(token));
  780. }
  781. template <typename CompletionToken,
  782. BOOST_ASIO_COMPLETION_SIGNATURE Sig0,
  783. BOOST_ASIO_COMPLETION_SIGNATURE Sig1,
  784. BOOST_ASIO_COMPLETION_SIGNATURE Sig2,
  785. typename Initiation>
  786. inline typename constraint<
  787. detail::async_result_has_initiate_memfn<
  788. CompletionToken, Sig0, Sig1, Sig2>::value,
  789. BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE3(CompletionToken, Sig0, Sig1, Sig2,
  790. (async_result<typename decay<CompletionToken>::type,
  791. Sig0, Sig1, Sig2>::initiate(declval<BOOST_ASIO_MOVE_ARG(Initiation)>(),
  792. declval<BOOST_ASIO_MOVE_ARG(CompletionToken)>())))>::type
  793. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation,
  794. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token)
  795. {
  796. return async_result<typename decay<CompletionToken>::type,
  797. Sig0, Sig1, Sig2>::initiate(BOOST_ASIO_MOVE_CAST(Initiation)(initiation),
  798. BOOST_ASIO_MOVE_CAST(CompletionToken)(token));
  799. }
  800. template <typename CompletionToken,
  801. BOOST_ASIO_COMPLETION_SIGNATURE Sig0,
  802. typename Initiation>
  803. inline typename constraint<
  804. !detail::async_result_has_initiate_memfn<
  805. CompletionToken, Sig0>::value,
  806. BOOST_ASIO_INITFN_RESULT_TYPE(CompletionToken, Sig0)>::type
  807. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation,
  808. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token)
  809. {
  810. async_completion<CompletionToken, Sig0> completion(token);
  811. BOOST_ASIO_MOVE_CAST(Initiation)(initiation)(
  812. BOOST_ASIO_MOVE_CAST(BOOST_ASIO_HANDLER_TYPE(CompletionToken,
  813. Sig0))(completion.completion_handler));
  814. return completion.result.get();
  815. }
  816. template <typename CompletionToken,
  817. BOOST_ASIO_COMPLETION_SIGNATURE Sig0,
  818. BOOST_ASIO_COMPLETION_SIGNATURE Sig1,
  819. typename Initiation>
  820. inline typename constraint<
  821. !detail::async_result_has_initiate_memfn<
  822. CompletionToken, Sig0, Sig1>::value,
  823. BOOST_ASIO_INITFN_RESULT_TYPE2(CompletionToken, Sig0, Sig1)>::type
  824. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation,
  825. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token)
  826. {
  827. async_completion<CompletionToken, Sig0, Sig1> completion(token);
  828. BOOST_ASIO_MOVE_CAST(Initiation)(initiation)(
  829. BOOST_ASIO_MOVE_CAST(BOOST_ASIO_HANDLER_TYPE2(CompletionToken,
  830. Sig0, Sig1))(completion.completion_handler));
  831. return completion.result.get();
  832. }
  833. template <typename CompletionToken,
  834. BOOST_ASIO_COMPLETION_SIGNATURE Sig0,
  835. BOOST_ASIO_COMPLETION_SIGNATURE Sig1,
  836. BOOST_ASIO_COMPLETION_SIGNATURE Sig2,
  837. typename Initiation>
  838. inline typename constraint<
  839. !detail::async_result_has_initiate_memfn<
  840. CompletionToken, Sig0, Sig1, Sig2>::value,
  841. BOOST_ASIO_INITFN_RESULT_TYPE3(CompletionToken, Sig0, Sig1, Sig2)>::type
  842. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation,
  843. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token)
  844. {
  845. async_completion<CompletionToken, Sig0, Sig1, Sig2> completion(token);
  846. BOOST_ASIO_MOVE_CAST(Initiation)(initiation)(
  847. BOOST_ASIO_MOVE_CAST(BOOST_ASIO_HANDLER_TYPE3(CompletionToken,
  848. Sig0, Sig1, Sig2))(completion.completion_handler));
  849. return completion.result.get();
  850. }
  851. #define BOOST_ASIO_PRIVATE_INITIATE_DEF(n) \
  852. template <typename CompletionToken, \
  853. BOOST_ASIO_COMPLETION_SIGNATURE Sig0, \
  854. typename Initiation, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  855. inline typename constraint< \
  856. detail::async_result_has_initiate_memfn< \
  857. CompletionToken, Sig0>::value, \
  858. BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE( \
  859. CompletionToken, Sig0, \
  860. (async_result<typename decay<CompletionToken>::type, \
  861. Sig0>::initiate( \
  862. declval<BOOST_ASIO_MOVE_ARG(Initiation)>(), \
  863. declval<BOOST_ASIO_MOVE_ARG(CompletionToken)>(), \
  864. BOOST_ASIO_VARIADIC_MOVE_DECLVAL(n))))>::type \
  865. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation, \
  866. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token, \
  867. BOOST_ASIO_VARIADIC_MOVE_PARAMS(n)) \
  868. { \
  869. return async_result<typename decay<CompletionToken>::type, \
  870. Sig0>::initiate( \
  871. BOOST_ASIO_MOVE_CAST(Initiation)(initiation), \
  872. BOOST_ASIO_MOVE_CAST(CompletionToken)(token), \
  873. BOOST_ASIO_VARIADIC_MOVE_ARGS(n)); \
  874. } \
  875. \
  876. template <typename CompletionToken, \
  877. BOOST_ASIO_COMPLETION_SIGNATURE Sig0, \
  878. BOOST_ASIO_COMPLETION_SIGNATURE Sig1, \
  879. typename Initiation, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  880. inline typename constraint< \
  881. detail::async_result_has_initiate_memfn< \
  882. CompletionToken, Sig0, Sig1>::value, \
  883. BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE2( \
  884. CompletionToken, Sig0, Sig1, \
  885. (async_result<typename decay<CompletionToken>::type, \
  886. Sig0, Sig1>::initiate( \
  887. declval<BOOST_ASIO_MOVE_ARG(Initiation)>(), \
  888. declval<BOOST_ASIO_MOVE_ARG(CompletionToken)>(), \
  889. BOOST_ASIO_VARIADIC_MOVE_DECLVAL(n))))>::type \
  890. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation, \
  891. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token, \
  892. BOOST_ASIO_VARIADIC_MOVE_PARAMS(n)) \
  893. { \
  894. return async_result<typename decay<CompletionToken>::type, \
  895. Sig0, Sig1>::initiate( \
  896. BOOST_ASIO_MOVE_CAST(Initiation)(initiation), \
  897. BOOST_ASIO_MOVE_CAST(CompletionToken)(token), \
  898. BOOST_ASIO_VARIADIC_MOVE_ARGS(n)); \
  899. } \
  900. \
  901. template <typename CompletionToken, \
  902. BOOST_ASIO_COMPLETION_SIGNATURE Sig0, \
  903. BOOST_ASIO_COMPLETION_SIGNATURE Sig1, \
  904. BOOST_ASIO_COMPLETION_SIGNATURE Sig2, \
  905. typename Initiation, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  906. inline typename constraint< \
  907. detail::async_result_has_initiate_memfn< \
  908. CompletionToken, Sig0, Sig1, Sig2>::value, \
  909. BOOST_ASIO_INITFN_DEDUCED_RESULT_TYPE3( \
  910. CompletionToken, Sig0, Sig1, Sig2, \
  911. (async_result<typename decay<CompletionToken>::type, \
  912. Sig0, Sig1, Sig2>::initiate( \
  913. declval<BOOST_ASIO_MOVE_ARG(Initiation)>(), \
  914. declval<BOOST_ASIO_MOVE_ARG(CompletionToken)>(), \
  915. BOOST_ASIO_VARIADIC_MOVE_DECLVAL(n))))>::type \
  916. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation, \
  917. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token, \
  918. BOOST_ASIO_VARIADIC_MOVE_PARAMS(n)) \
  919. { \
  920. return async_result<typename decay<CompletionToken>::type, \
  921. Sig0, Sig1, Sig2>::initiate( \
  922. BOOST_ASIO_MOVE_CAST(Initiation)(initiation), \
  923. BOOST_ASIO_MOVE_CAST(CompletionToken)(token), \
  924. BOOST_ASIO_VARIADIC_MOVE_ARGS(n)); \
  925. } \
  926. \
  927. template <typename CompletionToken, \
  928. BOOST_ASIO_COMPLETION_SIGNATURE Sig0, \
  929. typename Initiation, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  930. inline typename constraint< \
  931. !detail::async_result_has_initiate_memfn< \
  932. CompletionToken, Sig0>::value, \
  933. BOOST_ASIO_INITFN_RESULT_TYPE(CompletionToken, Sig0)>::type \
  934. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation, \
  935. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token, \
  936. BOOST_ASIO_VARIADIC_MOVE_PARAMS(n)) \
  937. { \
  938. async_completion<CompletionToken, \
  939. Sig0> completion(token); \
  940. \
  941. BOOST_ASIO_MOVE_CAST(Initiation)(initiation)( \
  942. BOOST_ASIO_MOVE_CAST(BOOST_ASIO_HANDLER_TYPE(CompletionToken, \
  943. Sig0))(completion.completion_handler), \
  944. BOOST_ASIO_VARIADIC_MOVE_ARGS(n)); \
  945. \
  946. return completion.result.get(); \
  947. } \
  948. \
  949. template <typename CompletionToken, \
  950. BOOST_ASIO_COMPLETION_SIGNATURE Sig0, \
  951. BOOST_ASIO_COMPLETION_SIGNATURE Sig1, \
  952. typename Initiation, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  953. inline typename constraint< \
  954. !detail::async_result_has_initiate_memfn< \
  955. CompletionToken, Sig0, Sig1>::value, \
  956. BOOST_ASIO_INITFN_RESULT_TYPE2(CompletionToken, Sig0, Sig1)>::type \
  957. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation, \
  958. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token, \
  959. BOOST_ASIO_VARIADIC_MOVE_PARAMS(n)) \
  960. { \
  961. async_completion<CompletionToken, \
  962. Sig0, Sig1> completion(token); \
  963. \
  964. BOOST_ASIO_MOVE_CAST(Initiation)(initiation)( \
  965. BOOST_ASIO_MOVE_CAST(BOOST_ASIO_HANDLER_TYPE2(CompletionToken, \
  966. Sig0, Sig1))(completion.completion_handler), \
  967. BOOST_ASIO_VARIADIC_MOVE_ARGS(n)); \
  968. \
  969. return completion.result.get(); \
  970. } \
  971. \
  972. template <typename CompletionToken, \
  973. BOOST_ASIO_COMPLETION_SIGNATURE Sig0, \
  974. BOOST_ASIO_COMPLETION_SIGNATURE Sig1, \
  975. BOOST_ASIO_COMPLETION_SIGNATURE Sig2, \
  976. typename Initiation, BOOST_ASIO_VARIADIC_TPARAMS(n)> \
  977. inline typename constraint< \
  978. !detail::async_result_has_initiate_memfn< \
  979. CompletionToken, Sig0, Sig1, Sig2>::value, \
  980. BOOST_ASIO_INITFN_RESULT_TYPE3(CompletionToken, Sig0, Sig1, Sig2)>::type \
  981. async_initiate(BOOST_ASIO_MOVE_ARG(Initiation) initiation, \
  982. BOOST_ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token, \
  983. BOOST_ASIO_VARIADIC_MOVE_PARAMS(n)) \
  984. { \
  985. async_completion<CompletionToken, \
  986. Sig0, Sig1, Sig2> completion(token); \
  987. \
  988. BOOST_ASIO_MOVE_CAST(Initiation)(initiation)( \
  989. BOOST_ASIO_MOVE_CAST(BOOST_ASIO_HANDLER_TYPE3(CompletionToken, \
  990. Sig0, Sig1, Sig2))(completion.completion_handler), \
  991. BOOST_ASIO_VARIADIC_MOVE_ARGS(n)); \
  992. \
  993. return completion.result.get(); \
  994. } \
  995. /**/
  996. BOOST_ASIO_VARIADIC_GENERATE(BOOST_ASIO_PRIVATE_INITIATE_DEF)
  997. #undef BOOST_ASIO_PRIVATE_INITIATE_DEF
  998. #endif // defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  999. #if defined(BOOST_ASIO_HAS_CONCEPTS) \
  1000. && defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES) \
  1001. && defined(BOOST_ASIO_HAS_DECLTYPE)
  1002. namespace detail {
  1003. template <typename... Signatures>
  1004. struct initiation_archetype
  1005. {
  1006. template <completion_handler_for<Signatures...> CompletionHandler>
  1007. void operator()(CompletionHandler&&) const
  1008. {
  1009. }
  1010. };
  1011. } // namespace detail
  1012. template <typename T, typename... Signatures>
  1013. BOOST_ASIO_CONCEPT completion_token_for =
  1014. detail::are_completion_signatures<Signatures...>::value
  1015. &&
  1016. requires(T&& t)
  1017. {
  1018. async_initiate<T, Signatures...>(
  1019. detail::initiation_archetype<Signatures...>{}, t);
  1020. };
  1021. #define BOOST_ASIO_COMPLETION_TOKEN_FOR(sig) \
  1022. ::boost::asio::completion_token_for<sig>
  1023. #define BOOST_ASIO_COMPLETION_TOKEN_FOR2(sig0, sig1) \
  1024. ::boost::asio::completion_token_for<sig0, sig1>
  1025. #define BOOST_ASIO_COMPLETION_TOKEN_FOR3(sig0, sig1, sig2) \
  1026. ::boost::asio::completion_token_for<sig0, sig1, sig2>
  1027. #else // defined(BOOST_ASIO_HAS_CONCEPTS)
  1028. // && defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  1029. // && defined(BOOST_ASIO_HAS_DECLTYPE)
  1030. #define BOOST_ASIO_COMPLETION_TOKEN_FOR(sig) typename
  1031. #define BOOST_ASIO_COMPLETION_TOKEN_FOR2(sig0, sig1) typename
  1032. #define BOOST_ASIO_COMPLETION_TOKEN_FOR3(sig0, sig1, sig2) typename
  1033. #endif // defined(BOOST_ASIO_HAS_CONCEPTS)
  1034. // && defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
  1035. // && defined(BOOST_ASIO_HAS_DECLTYPE)
  1036. namespace detail {
  1037. template <typename T, typename = void>
  1038. struct default_completion_token_impl
  1039. {
  1040. typedef void type;
  1041. };
  1042. template <typename T>
  1043. struct default_completion_token_impl<T,
  1044. typename void_type<typename T::default_completion_token_type>::type>
  1045. {
  1046. typedef typename T::default_completion_token_type type;
  1047. };
  1048. } // namespace detail
  1049. #if defined(GENERATING_DOCUMENTATION)
  1050. /// Traits type used to determine the default completion token type associated
  1051. /// with a type (such as an executor).
  1052. /**
  1053. * A program may specialise this traits type if the @c T template parameter in
  1054. * the specialisation is a user-defined type.
  1055. *
  1056. * Specialisations of this trait may provide a nested typedef @c type, which is
  1057. * a default-constructible completion token type.
  1058. */
  1059. template <typename T>
  1060. struct default_completion_token
  1061. {
  1062. /// If @c T has a nested type @c default_completion_token_type,
  1063. /// <tt>T::default_completion_token_type</tt>. Otherwise the typedef @c type
  1064. /// is not defined.
  1065. typedef see_below type;
  1066. };
  1067. #else
  1068. template <typename T>
  1069. struct default_completion_token
  1070. : detail::default_completion_token_impl<T>
  1071. {
  1072. };
  1073. #endif
  1074. #if defined(BOOST_ASIO_HAS_ALIAS_TEMPLATES)
  1075. template <typename T>
  1076. using default_completion_token_t = typename default_completion_token<T>::type;
  1077. #endif // defined(BOOST_ASIO_HAS_ALIAS_TEMPLATES)
  1078. #if defined(BOOST_ASIO_HAS_DEFAULT_FUNCTION_TEMPLATE_ARGUMENTS)
  1079. #define BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(e) \
  1080. = typename ::boost::asio::default_completion_token<e>::type
  1081. #define BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(e) \
  1082. = typename ::boost::asio::default_completion_token<e>::type()
  1083. #else // defined(BOOST_ASIO_HAS_DEFAULT_FUNCTION_TEMPLATE_ARGUMENTS)
  1084. #define BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(e)
  1085. #define BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(e)
  1086. #endif // defined(BOOST_ASIO_HAS_DEFAULT_FUNCTION_TEMPLATE_ARGUMENTS)
  1087. } // namespace asio
  1088. } // namespace boost
  1089. #include <boost/asio/detail/pop_options.hpp>
  1090. #endif // BOOST_ASIO_ASYNC_RESULT_HPP