summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/asio/include/asio/executor_work_guard.hpp
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/asio/include/asio/executor_work_guard.hpp')
-rw-r--r--3rdparty/asio/include/asio/executor_work_guard.hpp285
1 files changed, 239 insertions, 46 deletions
diff --git a/3rdparty/asio/include/asio/executor_work_guard.hpp b/3rdparty/asio/include/asio/executor_work_guard.hpp
index a791dcd41f3..72787ccdc83 100644
--- a/3rdparty/asio/include/asio/executor_work_guard.hpp
+++ b/3rdparty/asio/include/asio/executor_work_guard.hpp
@@ -1,8 +1,8 @@
//
// executor_work_guard.hpp
-// ~~~~~~~~~~~~~~~~~
+// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2016 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2024 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)
@@ -16,16 +16,28 @@
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
#include "asio/detail/config.hpp"
+
#include "asio/associated_executor.hpp"
#include "asio/detail/type_traits.hpp"
+#include "asio/execution.hpp"
#include "asio/is_executor.hpp"
#include "asio/detail/push_options.hpp"
namespace asio {
-/// An object of type @c executor_work_guard controls ownership of executor work
-/// within a scope.
+#if !defined(ASIO_EXECUTOR_WORK_GUARD_DECL)
+#define ASIO_EXECUTOR_WORK_GUARD_DECL
+
+template <typename Executor, typename = void, typename = void>
+class executor_work_guard;
+
+#endif // !defined(ASIO_EXECUTOR_WORK_GUARD_DECL)
+
+#if defined(GENERATING_DOCUMENTATION)
+
+/// An object of type @c executor_work_guard controls ownership of outstanding
+/// executor work within a scope.
template <typename Executor>
class executor_work_guard
{
@@ -37,15 +49,58 @@ public:
/**
* Stores a copy of @c e and calls <tt>on_work_started()</tt> on it.
*/
- explicit executor_work_guard(const executor_type& e) ASIO_NOEXCEPT
+ explicit executor_work_guard(const executor_type& e) noexcept;
+
+ /// Copy constructor.
+ executor_work_guard(const executor_work_guard& other) noexcept;
+
+ /// Move constructor.
+ executor_work_guard(executor_work_guard&& other) noexcept;
+
+ /// Destructor.
+ /**
+ * Unless the object has already been reset, or is in a moved-from state,
+ * calls <tt>on_work_finished()</tt> on the stored executor.
+ */
+ ~executor_work_guard();
+
+ /// Obtain the associated executor.
+ executor_type get_executor() const noexcept;
+
+ /// Whether the executor_work_guard object owns some outstanding work.
+ bool owns_work() const noexcept;
+
+ /// Indicate that the work is no longer outstanding.
+ /**
+ * Unless the object has already been reset, or is in a moved-from state,
+ * calls <tt>on_work_finished()</tt> on the stored executor.
+ */
+ void reset() noexcept;
+};
+
+#endif // defined(GENERATING_DOCUMENTATION)
+
+#if !defined(GENERATING_DOCUMENTATION)
+
+#if !defined(ASIO_NO_TS_EXECUTORS)
+
+template <typename Executor>
+class executor_work_guard<Executor,
+ enable_if_t<
+ is_executor<Executor>::value
+ >>
+{
+public:
+ typedef Executor executor_type;
+
+ explicit executor_work_guard(const executor_type& e) noexcept
: executor_(e),
owns_(true)
{
executor_.on_work_started();
}
- /// Copy constructor.
- executor_work_guard(const executor_work_guard& other) ASIO_NOEXCEPT
+ executor_work_guard(const executor_work_guard& other) noexcept
: executor_(other.executor_),
owns_(other.owns_)
{
@@ -53,45 +108,30 @@ public:
executor_.on_work_started();
}
-#if defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
- /// Move constructor.
- executor_work_guard(executor_work_guard&& other)
- : executor_(ASIO_MOVE_CAST(Executor)(other.executor_)),
+ executor_work_guard(executor_work_guard&& other) noexcept
+ : executor_(static_cast<Executor&&>(other.executor_)),
owns_(other.owns_)
{
other.owns_ = false;
}
-#endif // defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
- /// Destructor.
- /**
- * Unless the object has already been reset, or is in a moved-from state,
- * calls <tt>on_work_finished()</tt> on the stored executor.
- */
~executor_work_guard()
{
if (owns_)
executor_.on_work_finished();
}
- /// Obtain the associated executor.
- executor_type get_executor() const ASIO_NOEXCEPT
+ executor_type get_executor() const noexcept
{
return executor_;
}
- /// Whether the executor_work_guard object owns some outstanding work.
- bool owns_work() const ASIO_NOEXCEPT
+ bool owns_work() const noexcept
{
return owns_;
}
- /// Indicate that the work is no longer outstanding.
- /*
- * Unless the object has already been reset, or is in a moved-from state,
- * calls <tt>on_work_finished()</tt> on the stored executor.
- */
- void reset() ASIO_NOEXCEPT
+ void reset() noexcept
{
if (owns_)
{
@@ -108,56 +148,209 @@ private:
bool owns_;
};
+#endif // !defined(ASIO_NO_TS_EXECUTORS)
+
+template <typename Executor>
+class executor_work_guard<Executor,
+ enable_if_t<
+ !is_executor<Executor>::value
+ >,
+ enable_if_t<
+ execution::is_executor<Executor>::value
+ >>
+{
+public:
+ typedef Executor executor_type;
+
+ explicit executor_work_guard(const executor_type& e) noexcept
+ : executor_(e),
+ owns_(true)
+ {
+ new (&work_) work_type(asio::prefer(executor_,
+ execution::outstanding_work.tracked));
+ }
+
+ executor_work_guard(const executor_work_guard& other) noexcept
+ : executor_(other.executor_),
+ owns_(other.owns_)
+ {
+ if (owns_)
+ {
+ new (&work_) work_type(asio::prefer(executor_,
+ execution::outstanding_work.tracked));
+ }
+ }
+
+ executor_work_guard(executor_work_guard&& other) noexcept
+ : executor_(static_cast<Executor&&>(other.executor_)),
+ owns_(other.owns_)
+ {
+ if (owns_)
+ {
+ new (&work_) work_type(
+ static_cast<work_type&&>(
+ *static_cast<work_type*>(
+ static_cast<void*>(&other.work_))));
+ other.owns_ = false;
+ }
+ }
+
+ ~executor_work_guard()
+ {
+ if (owns_)
+ static_cast<work_type*>(static_cast<void*>(&work_))->~work_type();
+ }
+
+ executor_type get_executor() const noexcept
+ {
+ return executor_;
+ }
+
+ bool owns_work() const noexcept
+ {
+ return owns_;
+ }
+
+ void reset() noexcept
+ {
+ if (owns_)
+ {
+ static_cast<work_type*>(static_cast<void*>(&work_))->~work_type();
+ owns_ = false;
+ }
+ }
+
+private:
+ // Disallow assignment.
+ executor_work_guard& operator=(const executor_work_guard&);
+
+ typedef decay_t<
+ prefer_result_t<
+ const executor_type&,
+ execution::outstanding_work_t::tracked_t
+ >
+ > work_type;
+
+ executor_type executor_;
+ aligned_storage_t<sizeof(work_type), alignment_of<work_type>::value> work_;
+ bool owns_;
+};
+
+#endif // !defined(GENERATING_DOCUMENTATION)
+
/// Create an @ref executor_work_guard object.
+/**
+ * @param ex An executor.
+ *
+ * @returns A work guard constructed with the specified executor.
+ */
template <typename Executor>
-inline executor_work_guard<Executor> make_work_guard(const Executor& ex,
- typename enable_if<is_executor<Executor>::value>::type* = 0)
+ASIO_NODISCARD inline executor_work_guard<Executor>
+make_work_guard(const Executor& ex,
+ constraint_t<
+ is_executor<Executor>::value || execution::is_executor<Executor>::value
+ > = 0)
{
return executor_work_guard<Executor>(ex);
}
/// Create an @ref executor_work_guard object.
+/**
+ * @param ctx An execution context, from which an executor will be obtained.
+ *
+ * @returns A work guard constructed with the execution context's executor,
+ * obtained by performing <tt>ctx.get_executor()</tt>.
+ */
template <typename ExecutionContext>
-inline executor_work_guard<typename ExecutionContext::executor_type>
+ASIO_NODISCARD inline
+executor_work_guard<typename ExecutionContext::executor_type>
make_work_guard(ExecutionContext& ctx,
- typename enable_if<
- is_convertible<ExecutionContext&, execution_context&>::value>::type* = 0)
+ constraint_t<
+ is_convertible<ExecutionContext&, execution_context&>::value
+ > = 0)
{
return executor_work_guard<typename ExecutionContext::executor_type>(
ctx.get_executor());
}
/// Create an @ref executor_work_guard object.
+/**
+ * @param t An arbitrary object, such as a completion handler, for which the
+ * associated executor will be obtained.
+ *
+ * @returns A work guard constructed with the associated executor of the object
+ * @c t, which is obtained as if by calling <tt>get_associated_executor(t)</tt>.
+ */
template <typename T>
-inline executor_work_guard<typename associated_executor<T>::type>
-make_work_guard(const T& t,
- typename enable_if<!is_executor<T>::value &&
- !is_convertible<T&, execution_context&>::value>::type* = 0)
+ASIO_NODISCARD inline
+executor_work_guard<
+ typename constraint_t<
+ !is_executor<T>::value
+ && !execution::is_executor<T>::value
+ && !is_convertible<T&, execution_context&>::value,
+ associated_executor<T>
+ >::type>
+make_work_guard(const T& t)
{
- return executor_work_guard<typename associated_executor<T>::type>(
+ return executor_work_guard<associated_executor_t<T>>(
associated_executor<T>::get(t));
}
/// Create an @ref executor_work_guard object.
+/**
+ * @param t An arbitrary object, such as a completion handler, for which the
+ * associated executor will be obtained.
+ *
+ * @param ex An executor to be used as the candidate object when determining the
+ * associated executor.
+ *
+ * @returns A work guard constructed with the associated executor of the object
+ * @c t, which is obtained as if by calling <tt>get_associated_executor(t,
+ * ex)</tt>.
+ */
template <typename T, typename Executor>
-inline executor_work_guard<typename associated_executor<T, Executor>::type>
+ASIO_NODISCARD inline
+executor_work_guard<associated_executor_t<T, Executor>>
make_work_guard(const T& t, const Executor& ex,
- typename enable_if<is_executor<Executor>::value>::type* = 0)
+ constraint_t<
+ is_executor<Executor>::value || execution::is_executor<Executor>::value
+ > = 0)
{
- return executor_work_guard<typename associated_executor<T, Executor>::type>(
+ return executor_work_guard<associated_executor_t<T, Executor>>(
associated_executor<T, Executor>::get(t, ex));
}
/// Create an @ref executor_work_guard object.
+/**
+ * @param t An arbitrary object, such as a completion handler, for which the
+ * associated executor will be obtained.
+ *
+ * @param ctx An execution context, from which an executor is obtained to use as
+ * the candidate object for determining the associated executor.
+ *
+ * @returns A work guard constructed with the associated executor of the object
+ * @c t, which is obtained as if by calling <tt>get_associated_executor(t,
+ * ctx.get_executor())</tt>.
+ */
template <typename T, typename ExecutionContext>
-inline executor_work_guard<typename associated_executor<T,
- typename ExecutionContext::executor_type>::type>
+ASIO_NODISCARD inline executor_work_guard<
+ associated_executor_t<T, typename ExecutionContext::executor_type>>
make_work_guard(const T& t, ExecutionContext& ctx,
- typename enable_if<!is_executor<T>::value &&
- !is_convertible<T&, execution_context&>::value>::type* = 0)
+ constraint_t<
+ !is_executor<T>::value
+ > = 0,
+ constraint_t<
+ !execution::is_executor<T>::value
+ > = 0,
+ constraint_t<
+ !is_convertible<T&, execution_context&>::value
+ > = 0,
+ constraint_t<
+ is_convertible<ExecutionContext&, execution_context&>::value
+ > = 0)
{
- return executor_work_guard<typename associated_executor<T,
- typename ExecutionContext::executor_type>::type>(
+ return executor_work_guard<
+ associated_executor_t<T, typename ExecutionContext::executor_type>>(
associated_executor<T, typename ExecutionContext::executor_type>::get(
t, ctx.get_executor()));
}