//
// execution/submit.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2003-2023 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_EXECUTION_SUBMIT_HPP
#define ASIO_EXECUTION_SUBMIT_HPP
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
#include "asio/detail/config.hpp"
#if !defined(ASIO_NO_DEPRECATED)
#include "asio/detail/type_traits.hpp"
#include "asio/execution/detail/submit_receiver.hpp"
#include "asio/execution/executor.hpp"
#include "asio/execution/receiver.hpp"
#include "asio/execution/sender.hpp"
#include "asio/execution/start.hpp"
#include "asio/traits/submit_member.hpp"
#include "asio/traits/submit_free.hpp"
#include "asio/detail/push_options.hpp"
#if defined(GENERATING_DOCUMENTATION)
namespace asio {
namespace execution {
/// A customisation point that submits a sender to a receiver.
/**
* The name execution::submit denotes a customisation point object. For
* some subexpressions s and r, let S be a type such
* that decltype((s)) is S and let R be a type such
* that decltype((r)) is R. The expression
* execution::submit(s, r) is ill-formed if sender_to is
* not true. Otherwise, it is expression-equivalent to:
*
* @li s.submit(r), if that expression is valid and S models
* sender. If the function selected does not submit the receiver
* object r via the sender s, the program is ill-formed with
* no diagnostic required.
*
* @li Otherwise, submit(s, r), if that expression is valid and
* S models sender, with overload resolution performed in a
* context that includes the declaration void submit(); and that does
* not include a declaration of execution::submit. If the function
* selected by overload resolution does not submit the receiver object
* r via the sender s, the program is ill-formed with no
* diagnostic required.
*
* @li Otherwise, execution::start((new submit_receiver{s,r})->state_), where submit_receiver is an
* implementation-defined class template equivalent to:
* @code template
* struct submit_receiver {
* struct wrap {
* submit_receiver * p_;
* template
* requires receiver_of
* void set_value(As&&... as) &&
* noexcept(is_nothrow_receiver_of_v) {
* execution::set_value(std::move(p_->r_), (As&&) as...);
* delete p_;
* }
* template
* requires receiver
* void set_error(E&& e) && noexcept {
* execution::set_error(std::move(p_->r_), (E&&) e);
* delete p_;
* }
* void set_done() && noexcept {
* execution::set_done(std::move(p_->r_));
* delete p_;
* }
* };
* remove_cvref_t r_;
* connect_result_t state_;
* submit_receiver(S&& s, R&& r)
* : r_((R&&) r)
* , state_(execution::connect((S&&) s, wrap{this})) {}
* };
* @endcode
*/
inline constexpr unspecified submit = unspecified;
/// A type trait that determines whether a @c submit expression is
/// well-formed.
/**
* Class template @c can_submit is a trait that is derived from
* @c true_type if the expression execution::submit(std::declval(),
* std::declval()) is well formed; otherwise @c false_type.
*/
template
struct can_submit :
integral_constant
{
};
} // namespace execution
} // namespace asio
#else // defined(GENERATING_DOCUMENTATION)
namespace asio_execution_submit_fn {
using asio::declval;
using asio::enable_if;
using asio::execution::is_sender_to;
using asio::traits::submit_free;
using asio::traits::submit_member;
void submit();
enum overload_type
{
call_member,
call_free,
adapter,
ill_formed
};
template
struct call_traits
{
ASIO_STATIC_CONSTEXPR(overload_type, overload = ill_formed);
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
typedef void result_type;
};
template
struct call_traits::is_valid
>::type,
typename enable_if<
is_sender_to::value
>::type> :
submit_member
{
ASIO_STATIC_CONSTEXPR(overload_type, overload = call_member);
};
template
struct call_traits::is_valid
>::type,
typename enable_if<
submit_free::is_valid
>::type,
typename enable_if<
is_sender_to::value
>::type> :
submit_free
{
ASIO_STATIC_CONSTEXPR(overload_type, overload = call_free);
};
template
struct call_traits::is_valid
>::type,
typename enable_if<
!submit_free::is_valid
>::type,
typename enable_if<
is_sender_to::value
>::type>
{
ASIO_STATIC_CONSTEXPR(overload_type, overload = adapter);
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
typedef void result_type;
};
struct impl
{
#if defined(ASIO_HAS_MOVE)
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_member,
typename call_traits::result_type
>::type
operator()(S&& s, R&& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return ASIO_MOVE_CAST(S)(s).submit(ASIO_MOVE_CAST(R)(r));
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_free,
typename call_traits::result_type
>::type
operator()(S&& s, R&& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return submit(ASIO_MOVE_CAST(S)(s), ASIO_MOVE_CAST(R)(r));
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == adapter,
typename call_traits::result_type
>::type
operator()(S&& s, R&& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return asio::execution::start(
(new asio::execution::detail::submit_receiver(
ASIO_MOVE_CAST(S)(s), ASIO_MOVE_CAST(R)(r)))->state_);
}
#else // defined(ASIO_HAS_MOVE)
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_member,
typename call_traits::result_type
>::type
operator()(S& s, R& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return s.submit(r);
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_member,
typename call_traits::result_type
>::type
operator()(const S& s, R& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return s.submit(r);
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_free,
typename call_traits::result_type
>::type
operator()(S& s, R& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return submit(s, r);
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_free,
typename call_traits::result_type
>::type
operator()(const S& s, R& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return submit(s, r);
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == adapter,
typename call_traits::result_type
>::type
operator()(S& s, R& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return asio::execution::start(
(new asio::execution::detail::submit_receiver<
S&, R&>(s, r))->state_);
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == adapter,
typename call_traits::result_type
>::type
operator()(const S& s, R& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
asio::execution::start(
(new asio::execution::detail::submit_receiver<
const S&, R&>(s, r))->state_);
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_member,
typename call_traits::result_type
>::type
operator()(S& s, const R& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return s.submit(r);
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_member,
typename call_traits::result_type
>::type
operator()(const S& s, const R& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return s.submit(r);
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_free,
typename call_traits::result_type
>::type
operator()(S& s, const R& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return submit(s, r);
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_free,
typename call_traits::result_type
>::type
operator()(const S& s, const R& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return submit(s, r);
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == adapter,
typename call_traits::result_type
>::type
operator()(S& s, const R& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
asio::execution::start(
(new asio::execution::detail::submit_receiver<
S&, const R&>(s, r))->state_);
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == adapter,
typename call_traits::result_type
>::type
operator()(const S& s, const R& r) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
asio::execution::start(
(new asio::execution::detail::submit_receiver<
const S&, const R&>(s, r))->state_);
}
#endif // defined(ASIO_HAS_MOVE)
};
template
struct static_instance
{
static const T instance;
};
template
const T static_instance::instance = {};
} // namespace asio_execution_submit_fn
namespace asio {
namespace execution {
namespace {
static ASIO_CONSTEXPR const asio_execution_submit_fn::impl&
submit = asio_execution_submit_fn::static_instance<>::instance;
} // namespace
template
struct can_submit :
integral_constant::overload !=
asio_execution_submit_fn::ill_formed>
{
};
#if defined(ASIO_HAS_VARIABLE_TEMPLATES)
template
constexpr bool can_submit_v = can_submit::value;
#endif // defined(ASIO_HAS_VARIABLE_TEMPLATES)
template
struct is_nothrow_submit :
integral_constant::is_noexcept>
{
};
#if defined(ASIO_HAS_VARIABLE_TEMPLATES)
template
constexpr bool is_nothrow_submit_v
= is_nothrow_submit::value;
#endif // defined(ASIO_HAS_VARIABLE_TEMPLATES)
template
struct submit_result
{
typedef typename asio_execution_submit_fn::call_traits<
S, void(R)>::result_type type;
};
namespace detail {
template
void submit_helper(ASIO_MOVE_ARG(S) s, ASIO_MOVE_ARG(R) r)
{
execution::submit(ASIO_MOVE_CAST(S)(s), ASIO_MOVE_CAST(R)(r));
}
} // namespace detail
} // namespace execution
} // namespace asio
#endif // defined(GENERATING_DOCUMENTATION)
#include "asio/detail/pop_options.hpp"
#endif // !defined(ASIO_NO_DEPRECATED)
#endif // ASIO_EXECUTION_SUBMIT_HPP