// Copyright (c) 2016 The Zcash developers // Copyright (c) 2016-2024 The Hush developers // Distributed under the GPLv3 software license, see the accompanying // file COPYING or https://www.gnu.org/licenses/gpl-3.0.en.html /****************************************************************************** * Copyright © 2014-2019 The SuperNET Developers. * * * * See the AUTHORS, DEVELOPER-AGREEMENT and LICENSE files at * * the top-level directory of this distribution for the individual copyright * * holder information and the developer policies on copyright and licensing. * * * * Unless otherwise agreed in a custom licensing agreement, no part of the * * SuperNET software, including this file may be copied, modified, propagated * * or distributed except according to the terms contained in the LICENSE file * * * * Removal or modification of this copyright notice is prohibited. * * * ******************************************************************************/ #include "asyncrpcoperation.h" #include #include #include #include #include #include using namespace std; static boost::uuids::random_generator uuidgen; static std::map OperationStatusMap = { {OperationStatus::READY, "queued"}, {OperationStatus::EXECUTING, "executing"}, {OperationStatus::CANCELLED, "cancelled"}, {OperationStatus::FAILED, "failed"}, {OperationStatus::SUCCESS, "success"} }; /** * Every operation instance should have a globally unique id */ AsyncRPCOperation::AsyncRPCOperation() : error_code_(0), error_message_() { // Set a unique reference for each operation boost::uuids::uuid uuid = uuidgen(); id_ = "opid-" + boost::uuids::to_string(uuid); creation_time_ = (int64_t)time(NULL); set_state(OperationStatus::READY); } AsyncRPCOperation::AsyncRPCOperation(const AsyncRPCOperation& o) : id_(o.id_), creation_time_(o.creation_time_), state_(o.state_.load()), start_time_(o.start_time_), end_time_(o.end_time_), error_code_(o.error_code_), error_message_(o.error_message_), result_(o.result_) { } AsyncRPCOperation& AsyncRPCOperation::operator=( const AsyncRPCOperation& other ) { this->id_ = other.id_; this->creation_time_ = other.creation_time_; this->state_.store(other.state_.load()); this->start_time_ = other.start_time_; this->end_time_ = other.end_time_; this->error_code_ = other.error_code_; this->error_message_ = other.error_message_; this->result_ = other.result_; return *this; } AsyncRPCOperation::~AsyncRPCOperation() { } /** * Override this cancel() method if you can interrupt main() when executing. */ void AsyncRPCOperation::cancel() { if (isReady()) { set_state(OperationStatus::CANCELLED); } } /** * Start timing the execution run of the code you're interested in */ void AsyncRPCOperation::start_execution_clock() { std::lock_guard guard(lock_); start_time_ = std::chrono::system_clock::now(); } /** * Stop timing the execution run */ void AsyncRPCOperation::stop_execution_clock() { std::lock_guard guard(lock_); end_time_ = std::chrono::system_clock::now(); } /** * Implement this virtual method in any subclass. This is just an example implementation. */ void AsyncRPCOperation::main() { if (isCancelled()) { return; } set_state(OperationStatus::EXECUTING); start_execution_clock(); // Do some work here.. stop_execution_clock(); // If there was an error, you might set it like this: /* setErrorCode(123); setErrorMessage("Murphy's law"); setState(OperationStatus::FAILED); */ // Otherwise, if the operation was a success: UniValue v(UniValue::VSTR, "We have a result!"); set_result(v); set_state(OperationStatus::SUCCESS); } /** * Return the error of the completed operation as a UniValue object. * If there is no error, return null UniValue. */ UniValue AsyncRPCOperation::getError() const { if (!isFailed()) { return NullUniValue; } std::lock_guard guard(lock_); UniValue error(UniValue::VOBJ); error.push_back(Pair("code", this->error_code_)); error.push_back(Pair("message", this->error_message_)); return error; } /** * Return the result of the completed operation as a UniValue object. * If the operation did not succeed, return null UniValue. */ UniValue AsyncRPCOperation::getResult() const { if (!isSuccess()) { return NullUniValue; } std::lock_guard guard(lock_); return this->result_; } /** * Returns a status UniValue object. * If the operation has failed, it will include an error object. * If the operation has succeeded, it will include the result value. * If the operation was cancelled, there will be no error object or result value. */ UniValue AsyncRPCOperation::getStatus() const { OperationStatus status = this->getState(); UniValue obj(UniValue::VOBJ); obj.push_back(Pair("id", this->id_)); obj.push_back(Pair("status", OperationStatusMap[status])); obj.push_back(Pair("creation_time", this->creation_time_)); // TODO: Issue #1354: There may be other useful metadata to return to the user. UniValue err = this->getError(); if (!err.isNull()) { obj.push_back(Pair("error", err.get_obj())); } UniValue result = this->getResult(); if (!result.isNull()) { obj.push_back(Pair("result", result)); // Include execution time for successful operation std::chrono::duration elapsed_seconds = end_time_ - start_time_; obj.push_back(Pair("execution_secs", elapsed_seconds.count())); } return obj; } /** * Return the operation state in human readable form. */ std::string AsyncRPCOperation::getStateAsString() const { OperationStatus status = this->getState(); return OperationStatusMap[status]; }