server.cpp File Reference

#include <rpc/server.h>
#include <fs.h>
#include <key_io.h>
#include <rpc/util.h>
#include <shutdown.h>
#include <sync.h>
#include <util/strencodings.h>
#include <util/system.h>
#include <boost/signals2/signal.hpp>
#include <boost/algorithm/string/classification.hpp>
#include <boost/algorithm/string/split.hpp>
#include <memory>
#include <unordered_map>

Classes
struct	RPCCommandExecutionInfo
struct	RPCServerInfo
struct	RPCCommandExecution
struct	CRPCSignals

Functions
static bool fRPCInWarmup	GUARDED_BY (cs_rpcWarmup) = "RPC server started"
static bool	ExecuteCommand (const CRPCCommand &command, const JSONRPCRequest &request, UniValue &result, bool last_handler)
UniValue	help (const JSONRPCRequest &jsonRequest)
UniValue	stop (const JSONRPCRequest &jsonRequest)
static UniValue	uptime (const JSONRPCRequest &jsonRequest)
static UniValue	getrpcinfo (const JSONRPCRequest &request)
void	StartRPC ()
void	InterruptRPC ()
void	StopRPC ()
bool	IsRPCRunning ()
void	SetRPCWarmupStatus (const std::string &newStatus)
void	SetRPCWarmupFinished ()
bool	RPCIsInWarmup (std::string *outStatus)
bool	IsDeprecatedRPCEnabled (const std::string &method)
static UniValue	JSONRPCExecOne (JSONRPCRequest jreq, const UniValue &req)
std::string	JSONRPCExecBatch (const JSONRPCRequest &jreq, const UniValue &vReq)
static JSONRPCRequest	transformNamedArguments (const JSONRPCRequest &in, const std::vector< std::string > &argNames)
void	RPCSetTimerInterfaceIfUnset (RPCTimerInterface *iface)
void	RPCSetTimerInterface (RPCTimerInterface *iface)
void	RPCUnsetTimerInterface (RPCTimerInterface *iface)
void	RPCRunLater (const std::string &name, std::function< void()> func, int64_t nSeconds)
int	RPCSerializationFlags ()

Variables
static CCriticalSection	cs_rpcWarmup
static std::atomic< bool >	g_rpc_running {false}
static RPCTimerInterface *	timerInterface = nullptr
static std::map< std::string, std::unique_ptr< RPCTimerBase > >	deadlineTimers
static RPCServerInfo	g_rpc_server_info
static struct CRPCSignals	g_rpcSignals
static const CRPCCommand	vRPCCommands []
CRPCTable	tableRPC

Function Documentation

ExecuteCommand()

static bool ExecuteCommand ( const CRPCCommand &  command, const JSONRPCRequest &  request, UniValue &  result, bool  last_handler  )

static

getrpcinfo()

static UniValue getrpcinfo ( const JSONRPCRequest &  request )

static

GUARDED_BY()

static std::string rpcWarmupStatus GUARDED_BY ( cs_rpcWarmup  ) = "RPC server started"

static

help()

UniValue help

(

const JSONRPCRequest &

jsonRequest

)

InterruptRPC()

void InterruptRPC

(

)

IsDeprecatedRPCEnabled()

bool IsDeprecatedRPCEnabled

(

const std::string &

method

)

IsRPCRunning()

bool IsRPCRunning

(

)

Query whether RPC is running

JSONRPCExecBatch()

std::string JSONRPCExecBatch	(	const JSONRPCRequest &	jreq,
		const UniValue &	vReq
	)

JSONRPCExecOne()

static UniValue JSONRPCExecOne ( JSONRPCRequest  jreq, const UniValue &  req  )

static

RPCIsInWarmup()

bool RPCIsInWarmup

(

std::string *

outStatus

)

RPCRunLater()

void RPCRunLater	(	const std::string &	name,
		std::function< void()>	func,
		int64_t	nSeconds
	)

Run func nSeconds from now. Overrides previous timer <name> (if any).

RPCSerializationFlags()

int RPCSerializationFlags

(

)

RPCSetTimerInterface()

void RPCSetTimerInterface

(

RPCTimerInterface *

iface

)

Set the factory function for timers

RPCSetTimerInterfaceIfUnset()

void RPCSetTimerInterfaceIfUnset

(

RPCTimerInterface *

iface

)

Set the factory function for timer, but only, if unset

RPCUnsetTimerInterface()

void RPCUnsetTimerInterface

(

RPCTimerInterface *

iface

)

Unset factory function for timers

SetRPCWarmupFinished()

void SetRPCWarmupFinished

(

)

SetRPCWarmupStatus()

void SetRPCWarmupStatus

(

const std::string &

newStatus

)

Set the RPC warmup status. When this is done, all RPC calls will error out immediately with RPC_IN_WARMUP.

StartRPC()

void StartRPC

(

)

stop()

UniValue stop

(

const JSONRPCRequest &

jsonRequest

)

StopRPC()

void StopRPC

(

)

transformNamedArguments()

static JSONRPCRequest transformNamedArguments ( const JSONRPCRequest &  in, const std::vector< std::string > &  argNames  )

inlinestatic

Process named arguments into a vector of positional arguments, based on the passed-in specification for the RPC call's arguments.

uptime()

static UniValue uptime ( const JSONRPCRequest &  jsonRequest )

static

Variable Documentation

cs_rpcWarmup

CCriticalSection cs_rpcWarmup

static

deadlineTimers

std::map<std::string, std::unique_ptr<RPCTimerBase> > deadlineTimers

static

g_rpc_running

std::atomic<bool> g_rpc_running {false}

static

g_rpc_server_info

RPCServerInfo g_rpc_server_info

static

g_rpcSignals

struct CRPCSignals g_rpcSignals

static

tableRPC

CRPCTable tableRPC

timerInterface

RPCTimerInterface* timerInterface = nullptr

static

vRPCCommands

const CRPCCommand vRPCCommands[]

static

Initial value:

=
{ 
  
    
    { "control",            "getrpcinfo",             &getrpcinfo,             {}  },
    { "control",            "help",                   &help,                   {"command"}  },
    { "control",            "stop",                   &stop,                   {"wait"}  },
    { "control",            "uptime",                 &uptime,                 {}  },
}