//
// dispatch.hpp
// ~~~~~~~~~~~~
//
// Copyright (c) 2003-2020 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_DISPATCH_HPP
#define ASIO_DISPATCH_HPP
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
#include "asio/detail/config.hpp"
#include "asio/async_result.hpp"
#include "asio/detail/type_traits.hpp"
#include "asio/execution_context.hpp"
#include "asio/execution/executor.hpp"
#include "asio/is_executor.hpp"
#include "asio/detail/push_options.hpp"
namespace asio {
/// Submits a completion token or function object for execution.
/**
* This function submits an object for execution using the object's associated
* executor. The function object may be called from the current thread prior to
* returning from dispatch(). Otherwise, it is queued for execution.
*
* This function has the following effects:
*
* @li Constructs a function object handler of type @c Handler, initialized
* with handler(forward(token)).
*
* @li Constructs an object @c result of type async_result,
* initializing the object as result(handler).
*
* @li Obtains the handler's associated executor object @c ex by performing
* get_associated_executor(handler).
*
* @li Obtains the handler's associated allocator object @c alloc by performing
* get_associated_allocator(handler).
*
* @li Performs ex.dispatch(std::move(handler), alloc).
*
* @li Returns result.get().
*/
template
ASIO_INITFN_AUTO_RESULT_TYPE(CompletionToken, void()) dispatch(
ASIO_MOVE_ARG(CompletionToken) token);
/// Submits a completion token or function object for execution.
/**
* This function submits an object for execution using the specified executor.
* The function object may be called from the current thread prior to returning
* from dispatch(). Otherwise, it is queued for execution.
*
* This function has the following effects:
*
* @li Constructs a function object handler of type @c Handler, initialized
* with handler(forward(token)).
*
* @li Constructs an object @c result of type async_result,
* initializing the object as result(handler).
*
* @li Obtains the handler's associated executor object @c ex1 by performing
* get_associated_executor(handler).
*
* @li Creates a work object @c w by performing make_work(ex1).
*
* @li Obtains the handler's associated allocator object @c alloc by performing
* get_associated_allocator(handler).
*
* @li Constructs a function object @c f with a function call operator that
* performs ex1.dispatch(std::move(handler), alloc) followed by
* w.reset().
*
* @li Performs Executor(ex).dispatch(std::move(f), alloc).
*
* @li Returns result.get().
*/
template
ASIO_INITFN_AUTO_RESULT_TYPE(CompletionToken, void()) dispatch(
const Executor& ex,
ASIO_MOVE_ARG(CompletionToken) token
ASIO_DEFAULT_COMPLETION_TOKEN(Executor),
typename enable_if<
execution::is_executor::value || is_executor::value
>::type* = 0);
/// Submits a completion token or function object for execution.
/**
* @returns dispatch(ctx.get_executor(),
* forward(token)).
*/
template
ASIO_INITFN_AUTO_RESULT_TYPE(CompletionToken, void()) dispatch(
ExecutionContext& ctx,
ASIO_MOVE_ARG(CompletionToken) token
ASIO_DEFAULT_COMPLETION_TOKEN(
typename ExecutionContext::executor_type),
typename enable_if::value>::type* = 0);
} // namespace asio
#include "asio/detail/pop_options.hpp"
#include "asio/impl/dispatch.hpp"
#endif // ASIO_DISPATCH_HPP