|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356 |
- //
- // async_result.hpp
- // ~~~~~~~~~~~~~~~~
- //
- // Copyright (c) 2003-2019 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_ASYNC_RESULT_HPP
- #define ASIO_ASYNC_RESULT_HPP
-
- #if defined(_MSC_VER) && (_MSC_VER >= 1200)
- # pragma once
- #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
-
- #include "asio/detail/config.hpp"
- #include "asio/detail/type_traits.hpp"
- #include "asio/detail/variadic_templates.hpp"
-
- #include "asio/detail/push_options.hpp"
-
- namespace asio {
-
- /// An interface for customising the behaviour of an initiating function.
- /**
- * The async_result traits class is used for determining:
- *
- * @li the concrete completion handler type to be called at the end of the
- * asynchronous operation;
- *
- * @li the initiating function return type; and
- *
- * @li how the return value of the initiating function is obtained.
- *
- * The trait allows the handler and return types to be determined at the point
- * where the specific completion handler signature is known.
- *
- * This template may be specialised for user-defined completion token types.
- * The primary template assumes that the CompletionToken is the completion
- * handler.
- */
- template <typename CompletionToken, typename Signature>
- class async_result
- {
- public:
- /// The concrete completion handler type for the specific signature.
- typedef CompletionToken completion_handler_type;
-
- /// The return type of the initiating function.
- typedef void return_type;
-
- /// Construct an async result from a given handler.
- /**
- * When using a specalised async_result, the constructor has an opportunity
- * to initialise some state associated with the completion handler, which is
- * then returned from the initiating function.
- */
- explicit async_result(completion_handler_type& h)
- {
- (void)h;
- }
-
- /// Obtain the value to be returned from the initiating function.
- return_type get()
- {
- }
-
- #if defined(ASIO_HAS_VARIADIC_TEMPLATES) \
- || defined(GENERATING_DOCUMENTATION)
-
- /// Initiate the asynchronous operation that will produce the result, and
- /// obtain the value to be returned from the initiating function.
- template <typename Initiation, typename RawCompletionToken, typename... Args>
- static return_type initiate(
- ASIO_MOVE_ARG(Initiation) initiation,
- ASIO_MOVE_ARG(RawCompletionToken) token,
- ASIO_MOVE_ARG(Args)... args)
- {
- ASIO_MOVE_CAST(Initiation)(initiation)(
- ASIO_MOVE_CAST(RawCompletionToken)(token),
- ASIO_MOVE_CAST(Args)(args)...);
- }
-
- #else // defined(ASIO_HAS_VARIADIC_TEMPLATES)
- // || defined(GENERATING_DOCUMENTATION)
-
- template <typename Initiation, typename RawCompletionToken>
- static return_type initiate(
- ASIO_MOVE_ARG(Initiation) initiation,
- ASIO_MOVE_ARG(RawCompletionToken) token)
- {
- ASIO_MOVE_CAST(Initiation)(initiation)(
- ASIO_MOVE_CAST(RawCompletionToken)(token));
- }
-
- #define ASIO_PRIVATE_INITIATE_DEF(n) \
- template <typename Initiation, typename RawCompletionToken, \
- ASIO_VARIADIC_TPARAMS(n)> \
- static return_type initiate( \
- ASIO_MOVE_ARG(Initiation) initiation, \
- ASIO_MOVE_ARG(RawCompletionToken) token, \
- ASIO_VARIADIC_MOVE_PARAMS(n)) \
- { \
- ASIO_MOVE_CAST(Initiation)(initiation)( \
- ASIO_MOVE_CAST(RawCompletionToken)(token), \
- ASIO_VARIADIC_MOVE_ARGS(n)); \
- } \
- /**/
- ASIO_VARIADIC_GENERATE(ASIO_PRIVATE_INITIATE_DEF)
- #undef ASIO_PRIVATE_INITIATE_DEF
-
- #endif // defined(ASIO_HAS_VARIADIC_TEMPLATES)
- // || defined(GENERATING_DOCUMENTATION)
-
- private:
- async_result(const async_result&) ASIO_DELETED;
- async_result& operator=(const async_result&) ASIO_DELETED;
- };
-
- /// Helper template to deduce the handler type from a CompletionToken, capture
- /// a local copy of the handler, and then create an async_result for the
- /// handler.
- template <typename CompletionToken, typename Signature>
- struct async_completion
- {
- /// The real handler type to be used for the asynchronous operation.
- typedef typename asio::async_result<
- typename decay<CompletionToken>::type,
- Signature>::completion_handler_type completion_handler_type;
-
- #if defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
- /// Constructor.
- /**
- * The constructor creates the concrete completion handler and makes the link
- * between the handler and the asynchronous result.
- */
- explicit async_completion(CompletionToken& token)
- : completion_handler(static_cast<typename conditional<
- is_same<CompletionToken, completion_handler_type>::value,
- completion_handler_type&, CompletionToken&&>::type>(token)),
- result(completion_handler)
- {
- }
- #else // defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
- explicit async_completion(typename decay<CompletionToken>::type& token)
- : completion_handler(token),
- result(completion_handler)
- {
- }
-
- explicit async_completion(const typename decay<CompletionToken>::type& token)
- : completion_handler(token),
- result(completion_handler)
- {
- }
- #endif // defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
-
- /// A copy of, or reference to, a real handler object.
- #if defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
- typename conditional<
- is_same<CompletionToken, completion_handler_type>::value,
- completion_handler_type&, completion_handler_type>::type completion_handler;
- #else // defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
- completion_handler_type completion_handler;
- #endif // defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
-
- /// The result of the asynchronous operation's initiating function.
- async_result<typename decay<CompletionToken>::type, Signature> result;
- };
-
- namespace detail {
-
- template <typename CompletionToken, typename Signature>
- struct async_result_helper
- : async_result<typename decay<CompletionToken>::type, Signature>
- {
- };
-
- struct async_result_memfns_base
- {
- void initiate();
- };
-
- template <typename T>
- struct async_result_memfns_derived
- : T, async_result_memfns_base
- {
- };
-
- template <typename T, T>
- struct async_result_memfns_check
- {
- };
-
- template <typename>
- char (&async_result_initiate_memfn_helper(...))[2];
-
- template <typename T>
- char async_result_initiate_memfn_helper(
- async_result_memfns_check<
- void (async_result_memfns_base::*)(),
- &async_result_memfns_derived<T>::initiate>*);
-
- template <typename CompletionToken, typename Signature>
- struct async_result_has_initiate_memfn
- : integral_constant<bool, sizeof(async_result_initiate_memfn_helper<
- async_result<typename decay<CompletionToken>::type, Signature>
- >(0)) != 1>
- {
- };
-
- } // namespace detail
-
- #if defined(GENERATING_DOCUMENTATION)
- # define ASIO_INITFN_RESULT_TYPE(ct, sig) \
- void_or_deduced
- #elif defined(_MSC_VER) && (_MSC_VER < 1500)
- # define ASIO_INITFN_RESULT_TYPE(ct, sig) \
- typename ::asio::detail::async_result_helper< \
- ct, sig>::return_type
- #define ASIO_HANDLER_TYPE(ct, sig) \
- typename ::asio::detail::async_result_helper< \
- ct, sig>::completion_handler_type
- #else
- # define ASIO_INITFN_RESULT_TYPE(ct, sig) \
- typename ::asio::async_result< \
- typename ::asio::decay<ct>::type, sig>::return_type
- #define ASIO_HANDLER_TYPE(ct, sig) \
- typename ::asio::async_result< \
- typename ::asio::decay<ct>::type, sig>::completion_handler_type
- #endif
-
- #if defined(GENERATING_DOCUMENTATION)
-
- template <typename CompletionToken, typename Signature,
- typename Initiation, typename... Args>
- ASIO_INITFN_RESULT_TYPE(CompletionToken, Signature)
- async_initiate(ASIO_MOVE_ARG(Initiation) initiation,
- ASIO_NONDEDUCED_MOVE_ARG(CompletionToken),
- ASIO_MOVE_ARG(Args)... args);
-
- #elif defined(ASIO_HAS_VARIADIC_TEMPLATES)
-
- template <typename CompletionToken, typename Signature,
- typename Initiation, typename... Args>
- inline typename enable_if<
- detail::async_result_has_initiate_memfn<CompletionToken, Signature>::value,
- ASIO_INITFN_RESULT_TYPE(CompletionToken, Signature)>::type
- async_initiate(ASIO_MOVE_ARG(Initiation) initiation,
- ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token,
- ASIO_MOVE_ARG(Args)... args)
- {
- return async_result<typename decay<CompletionToken>::type,
- Signature>::initiate(ASIO_MOVE_CAST(Initiation)(initiation),
- ASIO_MOVE_CAST(CompletionToken)(token),
- ASIO_MOVE_CAST(Args)(args)...);
- }
-
- template <typename CompletionToken, typename Signature,
- typename Initiation, typename... Args>
- inline typename enable_if<
- !detail::async_result_has_initiate_memfn<CompletionToken, Signature>::value,
- ASIO_INITFN_RESULT_TYPE(CompletionToken, Signature)>::type
- async_initiate(ASIO_MOVE_ARG(Initiation) initiation,
- ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token,
- ASIO_MOVE_ARG(Args)... args)
- {
- async_completion<CompletionToken, Signature> completion(token);
-
- ASIO_MOVE_CAST(Initiation)(initiation)(
- ASIO_MOVE_CAST(ASIO_HANDLER_TYPE(CompletionToken,
- Signature))(completion.completion_handler),
- ASIO_MOVE_CAST(Args)(args)...);
-
- return completion.result.get();
- }
-
- #else // defined(ASIO_HAS_VARIADIC_TEMPLATES)
-
- template <typename CompletionToken, typename Signature, typename Initiation>
- inline typename enable_if<
- detail::async_result_has_initiate_memfn<CompletionToken, Signature>::value,
- ASIO_INITFN_RESULT_TYPE(CompletionToken, Signature)>::type
- async_initiate(ASIO_MOVE_ARG(Initiation) initiation,
- ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token)
- {
- return async_result<typename decay<CompletionToken>::type,
- Signature>::initiate(ASIO_MOVE_CAST(Initiation)(initiation),
- ASIO_MOVE_CAST(CompletionToken)(token));
- }
-
- template <typename CompletionToken, typename Signature, typename Initiation>
- inline typename enable_if<
- !detail::async_result_has_initiate_memfn<CompletionToken, Signature>::value,
- ASIO_INITFN_RESULT_TYPE(CompletionToken, Signature)>::type
- async_initiate(ASIO_MOVE_ARG(Initiation) initiation,
- ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token)
- {
- async_completion<CompletionToken, Signature> completion(token);
-
- ASIO_MOVE_CAST(Initiation)(initiation)(
- ASIO_MOVE_CAST(ASIO_HANDLER_TYPE(CompletionToken,
- Signature))(completion.completion_handler));
-
- return completion.result.get();
- }
-
- #define ASIO_PRIVATE_INITIATE_DEF(n) \
- template <typename CompletionToken, typename Signature, \
- typename Initiation, ASIO_VARIADIC_TPARAMS(n)> \
- inline typename enable_if< \
- detail::async_result_has_initiate_memfn< \
- CompletionToken, Signature>::value, \
- ASIO_INITFN_RESULT_TYPE(CompletionToken, Signature)>::type \
- async_initiate(ASIO_MOVE_ARG(Initiation) initiation, \
- ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token, \
- ASIO_VARIADIC_MOVE_PARAMS(n)) \
- { \
- return async_result<typename decay<CompletionToken>::type, \
- Signature>::initiate(ASIO_MOVE_CAST(Initiation)(initiation), \
- ASIO_MOVE_CAST(CompletionToken)(token), \
- ASIO_VARIADIC_MOVE_ARGS(n)); \
- } \
- \
- template <typename CompletionToken, typename Signature, \
- typename Initiation, ASIO_VARIADIC_TPARAMS(n)> \
- inline typename enable_if< \
- !detail::async_result_has_initiate_memfn< \
- CompletionToken, Signature>::value, \
- ASIO_INITFN_RESULT_TYPE(CompletionToken, Signature)>::type \
- async_initiate(ASIO_MOVE_ARG(Initiation) initiation, \
- ASIO_NONDEDUCED_MOVE_ARG(CompletionToken) token, \
- ASIO_VARIADIC_MOVE_PARAMS(n)) \
- { \
- async_completion<CompletionToken, Signature> completion(token); \
- \
- ASIO_MOVE_CAST(Initiation)(initiation)( \
- ASIO_MOVE_CAST(ASIO_HANDLER_TYPE(CompletionToken, \
- Signature))(completion.completion_handler), \
- ASIO_VARIADIC_MOVE_ARGS(n)); \
- \
- return completion.result.get(); \
- } \
- /**/
- ASIO_VARIADIC_GENERATE(ASIO_PRIVATE_INITIATE_DEF)
- #undef ASIO_PRIVATE_INITIATE_DEF
-
- #endif // defined(ASIO_HAS_VARIADIC_TEMPLATES)
-
- } // namespace asio
-
- #include "asio/detail/pop_options.hpp"
-
- #endif // ASIO_ASYNC_RESULT_HPP
|