AnyOperation.hpp

//------------------------------------------------------------------------------
/*
    This file is part of clio: https://github.com/XRPLF/clio
    Copyright (c) 2024, the clio developers.
 
    Permission to use, copy, modify, and distribute this software for any
    purpose with or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#pragma once
 
#include "util/async/Error.hpp"
#include "util/async/impl/ErasedOperation.hpp"
 
#include <fmt/core.h>
#include <fmt/std.h>
 
#include <any>
#include <expected>
#include <thread>
#include <type_traits>
#include <utility>
 
// TODO: In the future, perhaps cancel and requestStop should be combined into one.
// Users of the library should not care whether the operation is cancellable or stoppable - users just want to cancel
// it whatever that means internally.
 
namespace util::async {
 
template <typename RetType>
class AnyOperation {
public:
    /* implicit */ AnyOperation(impl::ErasedOperation&& operation) : operation_{std::move(operation)}
    {
    }
 
    ~AnyOperation() = default;
 
    AnyOperation(AnyOperation const&) = delete;
    AnyOperation(AnyOperation&&) = default;
    AnyOperation&
    operator=(AnyOperation const&) = delete;
    AnyOperation&
    operator=(AnyOperation&&) = default;
 
    void
    wait() noexcept
    {
        operation_.wait();
    }
 
    void
    abort()
    {
        operation_.abort();
    }
 
    [[nodiscard]] std::expected<RetType, ExecutionError>
    get()
    {
        try {
            auto data = operation_.get();
            if (not data)
                return std::unexpected(std::move(data).error());
 
            if constexpr (std::is_void_v<RetType>) {
                return {};
            } else {
                return std::any_cast<RetType>(std::move(data).value());
            }
 
        } catch (std::bad_any_cast const& e) {
            return std::unexpected{ExecutionError(fmt::format("{}", std::this_thread::get_id()), "Bad any cast")};
        }
    }
 
    void
    invoke()
    {
        operation_.invoke();
    }
 
private:
    impl::ErasedOperation operation_;
};
 
}  // namespace util::async