//
// execution/schedule.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2003-2022 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_SCHEDULE_HPP
#define ASIO_EXECUTION_SCHEDULE_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/executor.hpp"
#include "asio/traits/schedule_member.hpp"
#include "asio/traits/schedule_free.hpp"
#include "asio/detail/push_options.hpp"
#if defined(GENERATING_DOCUMENTATION)
namespace asio {
namespace execution {
/// A customisation point that is used to obtain a sender from a scheduler.
/**
* The name execution::schedule denotes a customisation point object.
* For some subexpression s, let S be a type such that
* decltype((s)) is S. The expression
* execution::schedule(s) is expression-equivalent to:
*
* @li s.schedule(), if that expression is valid and its type models
* sender.
*
* @li Otherwise, schedule(s), if that expression is valid and its
* type models sender with overload resolution performed in a context
* that includes the declaration void schedule(); and that does not
* include a declaration of execution::schedule.
*
* @li Otherwise, S if S satisfies executor.
*
* @li Otherwise, execution::schedule(s) is ill-formed.
*/
inline constexpr unspecified schedule = unspecified;
/// A type trait that determines whether a @c schedule expression is
/// well-formed.
/**
* Class template @c can_schedule is a trait that is derived from @c true_type
* if the expression execution::schedule(std::declval()) is well
* formed; otherwise @c false_type.
*/
template
struct can_schedule :
integral_constant
{
};
} // namespace execution
} // namespace asio
#else // defined(GENERATING_DOCUMENTATION)
namespace asio_execution_schedule_fn {
using asio::decay;
using asio::declval;
using asio::enable_if;
using asio::execution::is_executor;
using asio::traits::schedule_free;
using asio::traits::schedule_member;
void schedule();
enum overload_type
{
identity,
call_member,
call_free,
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> :
schedule_member
{
ASIO_STATIC_CONSTEXPR(overload_type, overload = call_member);
};
template
struct call_traits::is_valid
>::type,
typename enable_if<
schedule_free::is_valid
>::type> :
schedule_free
{
ASIO_STATIC_CONSTEXPR(overload_type, overload = call_free);
};
template
struct call_traits::is_valid
>::type,
typename enable_if<
!schedule_free::is_valid
>::type,
typename enable_if<
is_executor::type>::value
>::type>
{
ASIO_STATIC_CONSTEXPR(overload_type, overload = identity);
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
#if defined(ASIO_HAS_MOVE)
typedef ASIO_MOVE_ARG(S) result_type;
#else // defined(ASIO_HAS_MOVE)
typedef ASIO_MOVE_ARG(typename decay::type) result_type;
#endif // defined(ASIO_HAS_MOVE)
};
struct impl
{
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == identity,
typename call_traits::result_type
>::type
operator()(ASIO_MOVE_ARG(S) s) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return ASIO_MOVE_CAST(S)(s);
}
#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) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return ASIO_MOVE_CAST(S)(s).schedule();
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_free,
typename call_traits::result_type
>::type
operator()(S&& s) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return schedule(ASIO_MOVE_CAST(S)(s));
}
#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) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return s.schedule();
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_member,
typename call_traits::result_type
>::type
operator()(const S& s) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return s.schedule();
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_free,
typename call_traits::result_type
>::type
operator()(S& s) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return schedule(s);
}
template
ASIO_CONSTEXPR typename enable_if<
call_traits::overload == call_free,
typename call_traits::result_type
>::type
operator()(const S& s) const
ASIO_NOEXCEPT_IF((
call_traits::is_noexcept))
{
return schedule(s);
}
#endif // defined(ASIO_HAS_MOVE)
};
template
struct static_instance
{
static const T instance;
};
template
const T static_instance::instance = {};
} // namespace asio_execution_schedule_fn
namespace asio {
namespace execution {
namespace {
static ASIO_CONSTEXPR const asio_execution_schedule_fn::impl&
schedule = asio_execution_schedule_fn::static_instance<>::instance;
} // namespace
template
struct can_schedule :
integral_constant::overload !=
asio_execution_schedule_fn::ill_formed>
{
};
#if defined(ASIO_HAS_VARIABLE_TEMPLATES)
template
constexpr bool can_schedule_v = can_schedule::value;
#endif // defined(ASIO_HAS_VARIABLE_TEMPLATES)
template
struct is_nothrow_schedule :
integral_constant::is_noexcept>
{
};
#if defined(ASIO_HAS_VARIABLE_TEMPLATES)
template
constexpr bool is_nothrow_schedule_v
= is_nothrow_schedule::value;
#endif // defined(ASIO_HAS_VARIABLE_TEMPLATES)
} // namespace execution
} // namespace asio
#endif // defined(GENERATING_DOCUMENTATION)
#include "asio/detail/pop_options.hpp"
#endif // !defined(ASIO_NO_DEPRECATED)
#endif // ASIO_EXECUTION_SCHEDULE_HPP