mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 02:55:50 +00:00
1d42c4f6de
Per XLS-0095, we are taking steps to rename ripple(d) to xrpl(d). This change specifically removes all copyright notices referencing Ripple, XRPLF, and certain affiliated contributors upon mutual agreement, so the notice in the LICENSE.md file applies throughout. Copyright notices referencing external contributions remain as-is. Duplicate verbiage is also removed.
90 lines
2.3 KiB
C++
90 lines
2.3 KiB
C++
#ifndef XRPL_SERVER_SPAWN_H_INCLUDED
|
|
#define XRPL_SERVER_SPAWN_H_INCLUDED
|
|
|
|
#include <xrpl/basics/Log.h>
|
|
|
|
#include <boost/asio/spawn.hpp>
|
|
#include <boost/asio/strand.hpp>
|
|
|
|
#include <concepts>
|
|
#include <type_traits>
|
|
|
|
namespace ripple::util {
|
|
namespace impl {
|
|
|
|
template <typename T>
|
|
concept IsStrand = std::same_as<
|
|
std::decay_t<T>,
|
|
boost::asio::strand<typename std::decay_t<T>::inner_executor_type>>;
|
|
|
|
/**
|
|
* @brief A completion handler that restores `boost::asio::spawn`'s behaviour
|
|
* from Boost 1.83
|
|
*
|
|
* This is intended to be passed as the third argument to `boost::asio::spawn`
|
|
* so that exceptions are not ignored but propagated to `io_context.run()` call
|
|
* site.
|
|
*
|
|
* @param ePtr The exception that was caught on the coroutine
|
|
*/
|
|
inline constexpr auto kPROPAGATE_EXCEPTIONS = [](std::exception_ptr ePtr) {
|
|
if (ePtr)
|
|
{
|
|
try
|
|
{
|
|
std::rethrow_exception(ePtr);
|
|
}
|
|
catch (std::exception const& e)
|
|
{
|
|
JLOG(debugLog().warn()) << "Spawn exception: " << e.what();
|
|
throw;
|
|
}
|
|
catch (...)
|
|
{
|
|
JLOG(debugLog().warn()) << "Spawn exception: Unknown";
|
|
throw;
|
|
}
|
|
}
|
|
};
|
|
|
|
} // namespace impl
|
|
|
|
/**
|
|
* @brief Spawns a coroutine using `boost::asio::spawn`
|
|
*
|
|
* @note This uses kPROPAGATE_EXCEPTIONS to force asio to propagate exceptions
|
|
* through `io_context`
|
|
* @note Since implicit strand was removed from boost::asio::spawn this helper
|
|
* function adds the strand back
|
|
*
|
|
* @tparam Ctx The type of the context/strand
|
|
* @tparam F The type of the function to execute
|
|
* @param ctx The execution context
|
|
* @param func The function to execute. Must return `void`
|
|
*/
|
|
template <typename Ctx, typename F>
|
|
requires std::is_invocable_r_v<void, F, boost::asio::yield_context>
|
|
void
|
|
spawn(Ctx&& ctx, F&& func)
|
|
{
|
|
if constexpr (impl::IsStrand<Ctx>)
|
|
{
|
|
boost::asio::spawn(
|
|
std::forward<Ctx>(ctx),
|
|
std::forward<F>(func),
|
|
impl::kPROPAGATE_EXCEPTIONS);
|
|
}
|
|
else
|
|
{
|
|
boost::asio::spawn(
|
|
boost::asio::make_strand(
|
|
boost::asio::get_associated_executor(std::forward<Ctx>(ctx))),
|
|
std::forward<F>(func),
|
|
impl::kPROPAGATE_EXCEPTIONS);
|
|
}
|
|
}
|
|
|
|
} // namespace ripple::util
|
|
|
|
#endif
|