server.h

Go to the documentation of this file.

// Copyright (c) 2010 Satoshi Nakamoto
// Copyright (c) 2009-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_RPC_SERVER_H
#define BITCOIN_RPC_SERVER_H
 
#include <rpc/request.h>
#include <rpc/util.h>
 
#include <cstdint>
#include <functional>
#include <map>
#include <string>
#include <string_view>
 
#include <univalue.h>
 
class CRPCCommand;
 
bool IsRPCRunning();
 
void RpcInterruptionPoint();
 
void SetRPCWarmupStatus(const std::string& newStatus);
void SetRPCWarmupStarting();
/* Mark warmup as done.  RPC calls will be processed from now on.  */
void SetRPCWarmupFinished();
 
/* returns the current warmup state.  */
bool RPCIsInWarmup(std::string *outStatus);
 
typedef RPCMethod (*RpcMethodFnType)();
 
class CRPCCommand
{
public:
    using Actor = std::function<bool(const JSONRPCRequest& request, UniValue& result, bool last_handler)>;
 
    CRPCCommand(std::string category, std::string name, Actor actor, std::vector<std::pair<std::string, bool>> args, intptr_t unique_id)
        : category(std::move(category)), name(std::move(name)), actor(std::move(actor)), argNames(std::move(args)),
          unique_id(unique_id)
    {
    }
 
    CRPCCommand(std::string category, RpcMethodFnType fn)
        : CRPCCommand(
              category,
              fn().m_name,
              [fn](const JSONRPCRequest& request, UniValue& result, bool) { result = fn().HandleRequest(request); return true; },
              fn().GetArgNames(),
              intptr_t(fn))
    {
        this->metadata_fn = fn;
    }
 
    std::string category;
    std::string name;
    Actor actor;
    std::vector<std::pair<std::string, bool>> argNames;
    intptr_t unique_id;
    RpcMethodFnType metadata_fn{nullptr};
};
 
class CRPCTable
{
private:
    std::map<std::string, std::vector<const CRPCCommand*>> mapCommands;
public:
    CRPCTable();
    std::string help(std::string_view name, const JSONRPCRequest& helpreq) const;
 
    UniValue execute(const JSONRPCRequest &request) const;
 
    std::vector<std::string> listCommands() const;
    UniValue buildOpenRPCDoc(bool include_hidden = false) const;
 
    UniValue dumpArgMap(const JSONRPCRequest& request) const;
 
    void appendCommand(const std::string& name, const CRPCCommand* pcmd);
    bool removeCommand(const std::string& name, const CRPCCommand* pcmd);
};
 
bool IsDeprecatedRPCEnabled(const std::string& method);
 
extern CRPCTable tableRPC;
 
void StartRPC();
void InterruptRPC();
void StopRPC();
UniValue JSONRPCExec(const JSONRPCRequest& jreq, bool catch_errors);
 
#endif // BITCOIN_RPC_SERVER_H