//
// execution/connect.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_CONNECT_HPP
#define ASIO_EXECUTION_CONNECT_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/as_invocable.hpp"
#include "asio/execution/detail/as_operation.hpp"
#include "asio/execution/detail/as_receiver.hpp"
#include "asio/execution/executor.hpp"
#include "asio/execution/operation_state.hpp"
#include "asio/execution/receiver.hpp"
#include "asio/execution/sender.hpp"
#include "asio/traits/connect_member.hpp"
#include "asio/traits/connect_free.hpp"
#include "asio/detail/push_options.hpp"
#if defined(GENERATING_DOCUMENTATION)
namespace asio {
namespace execution {
/// A customisation point that connects a sender to a receiver.
/**
* The name execution::connect 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::connect(s, r) is expression-equivalent to:
*
* @li s.connect(r), if that expression is valid, if its type
* satisfies operation_state, and if S satisfies
* sender.
*
* @li Otherwise, connect(s, r), if that expression is valid, if its
* type satisfies operation_state, and if S satisfies
* sender, with overload resolution performed in a context that
* includes the declaration void connect(); and that does not include
* a declaration of execution::connect.
*
* @li Otherwise, as_operation{s, r}, if r is not an instance
* of as_receiver for some type F, and if
* receiver_of && executor_of,
* as_invocable, S>> is true, where
* as_operation is an implementation-defined class equivalent to
* @code template
* struct as_operation
* {
* remove_cvref_t e_;
* remove_cvref_t r_;
* void start() noexcept try {
* execution::execute(std::move(e_),
* as_invocable, S>{r_});
* } catch(...) {
* execution::set_error(std::move(r_), current_exception());
* }
* }; @endcode
* and as_invocable is a class template equivalent to the following:
* @code template
* struct as_invocable
* {
* R* r_;
* explicit as_invocable(R& r) noexcept
* : r_(std::addressof(r)) {}
* as_invocable(as_invocable && other) noexcept
* : r_(std::exchange(other.r_, nullptr)) {}
* ~as_invocable() {
* if(r_)
* execution::set_done(std::move(*r_));
* }
* void operator()() & noexcept try {
* execution::set_value(std::move(*r_));
* r_ = nullptr;
* } catch(...) {
* execution::set_error(std::move(*r_), current_exception());
* r_ = nullptr;
* }
* };
* @endcode
*
* @li Otherwise, execution::connect(s, r) is ill-formed.
*/
inline constexpr unspecified connect = unspecified;
/// A type trait that determines whether a @c connect expression is
/// well-formed.
/**
* Class template @c can_connect is a trait that is derived from
* @c true_type if the expression execution::connect(std::declval(),
* std::declval()) is well formed; otherwise @c false_type.
*/
template
struct can_connect :
integral_constant
{
};
/// A type trait to determine the result of a @c connect expression.
template
struct connect_result
{
/// The type of the connect expression.
/**
* The type of the expression execution::connect(std::declval(),
* std::declval()).
*/
typedef automatically_determined type;
};
/// A type alis to determine the result of a @c connect expression.
template
using connect_result_t = typename connect_result::type;
} // namespace execution
} // namespace asio
#else // defined(GENERATING_DOCUMENTATION)
namespace asio_execution_connect_fn {
using asio::conditional;
using asio::declval;
using asio::enable_if;
using asio::execution::detail::as_invocable;
using asio::execution::detail::as_operation;
using asio::execution::detail::is_as_receiver;
using asio::execution::is_executor_of;
using asio::execution::is_operation_state;
using asio::execution::is_receiver;
using asio::execution::is_sender;
using asio::false_type;
using asio::remove_cvref;
using asio::traits::connect_free;
using asio::traits::connect_member;
void connect();
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_operation_state::result_type>::value
>::type,
typename enable_if<
is_sender::type>::value
>::type> :
connect_member
{
ASIO_STATIC_CONSTEXPR(overload_type, overload = call_member);
};
template
struct call_traits::is_valid
>::type,
typename enable_if<
connect_free::is_valid
>::type,
typename enable_if<
is_operation_state::result_type>::value
>::type,
typename enable_if<
is_sender::type>::value
>::type> :
connect_free
{
ASIO_STATIC_CONSTEXPR(overload_type, overload = call_free);
};
template
struct call_traits::is_valid
>::type,
typename enable_if<
!connect_free::is_valid
>::type,
typename enable_if<
is_receiver::value
>::type,
typename enable_if<
conditional<
!is_as_receiver<
typename remove_cvref::type
>::value,
is_executor_of<
typename remove_cvref::type,
as_invocable::type, S>
>,
false_type
>::type::value
>::type>
{
ASIO_STATIC_CONSTEXPR(overload_type, overload = adapter);
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
typedef as_operation 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).connect(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 connect(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 typename call_traits::result_type(
ASIO_MOVE_CAST(S)(s), ASIO_MOVE_CAST(R)(r));
}
#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.connect(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.connect(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 connect(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 connect(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 typename call_traits::result_type(s, r);
}
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))
{
return typename call_traits::result_type(s, r);
}
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.connect(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.connect(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 connect(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 connect(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))
{
return typename call_traits::result_type(s, r);
}
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))
{
return typename call_traits::result_type(s, r);
}
#endif // defined(ASIO_HAS_MOVE)
};
template
struct static_instance
{
static const T instance;
};
template
const T static_instance::instance = {};
} // namespace asio_execution_connect_fn
namespace asio {
namespace execution {
namespace {
static ASIO_CONSTEXPR const asio_execution_connect_fn::impl&
connect = asio_execution_connect_fn::static_instance<>::instance;
} // namespace
template
struct can_connect :
integral_constant::overload !=
asio_execution_connect_fn::ill_formed>
{
};
#if defined(ASIO_HAS_VARIABLE_TEMPLATES)
template
constexpr bool can_connect_v = can_connect::value;
#endif // defined(ASIO_HAS_VARIABLE_TEMPLATES)
template
struct is_nothrow_connect :
integral_constant::is_noexcept>
{
};
#if defined(ASIO_HAS_VARIABLE_TEMPLATES)
template
constexpr bool is_nothrow_connect_v
= is_nothrow_connect::value;
#endif // defined(ASIO_HAS_VARIABLE_TEMPLATES)
template
struct connect_result
{
typedef typename asio_execution_connect_fn::call_traits<
S, void(R)>::result_type type;
};
#if defined(ASIO_HAS_ALIAS_TEMPLATES)
template
using connect_result_t = typename connect_result::type;
#endif // defined(ASIO_HAS_ALIAS_TEMPLATES)
} // namespace execution
} // namespace asio
#endif // defined(GENERATING_DOCUMENTATION)
#include "asio/detail/pop_options.hpp"
#endif // !defined(ASIO_NO_DEPRECATED)
#endif // ASIO_EXECUTION_CONNECT_HPP