server.cpp File Reference

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

Include dependency graph for server.cpp:

Go to the source code of this file.

Classes
struct	RPCCommandExecutionInfo
struct	RPCServerInfo
struct	RPCCommandExecution
struct	CRPCSignals

Functions
static bool fRPCInWarmup	GUARDED_BY (g_rpc_warmup_mutex) = "RPC server started"
static std::map< std::string, std::unique_ptr< RPCTimerBase > > deadlineTimers	GUARDED_BY (g_deadline_timers_mutex)
static bool	ExecuteCommand (const CRPCCommand &command, const JSONRPCRequest &request, UniValue &result, bool last_handler)
static RPCHelpMan	help ()
static RPCHelpMan	stop ()
static RPCHelpMan	uptime ()
static RPCHelpMan	getrpcinfo ()
void	StartRPC ()
void	InterruptRPC ()
void	StopRPC ()
bool	IsRPCRunning ()
	Query whether RPC is running. More...
void	RpcInterruptionPoint ()
	Throw JSONRPCError if RPC is not running. More...
void	SetRPCWarmupStatus (const std::string &newStatus)
	Set the RPC warmup status. More...
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)
	Process named arguments into a vector of positional arguments, based on the passed-in specification for the RPC call's arguments. More...
void	RPCSetTimerInterfaceIfUnset (RPCTimerInterface *iface)
	Set the factory function for timer, but only, if unset. More...
void	RPCSetTimerInterface (RPCTimerInterface *iface)
	Set the factory function for timers. More...
void	RPCUnsetTimerInterface (RPCTimerInterface *iface)
	Unset factory function for timers. More...
void	RPCRunLater (const std::string &name, std::function< void()> func, int64_t nSeconds)
	Run func nSeconds from now. More...
int	RPCSerializationFlags ()

Variables
static Mutex	g_rpc_warmup_mutex
static std::atomic< bool >	g_rpc_running {false}
static RPCTimerInterface *	timerInterface = nullptr
static Mutex	g_deadline_timers_mutex
static RPCServerInfo	g_rpc_server_info
static struct CRPCSignals	g_rpcSignals
static const CRPCCommand	vRPCCommands []
CRPCTable	tableRPC

Function Documentation

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

static

Definition at line 457 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

static RPCHelpMan getrpcinfo ( )

static

Definition at line 200 of file server.cpp.

Here is the call graph for this function:

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

static

static std::map<std::string, std::unique_ptr<RPCTimerBase> > deadlineTimers GUARDED_BY ( g_deadline_timers_mutex  )

static

static RPCHelpMan help ( )

static

Definition at line 133 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void InterruptRPC

(

)

Definition at line 291 of file server.cpp.

Here is the caller graph for this function:

bool IsDeprecatedRPCEnabled

(

const std::string &

method

)

Definition at line 346 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool IsRPCRunning

(

)

Query whether RPC is running.

Definition at line 315 of file server.cpp.

Here is the caller graph for this function:

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

Definition at line 376 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

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

static

Definition at line 353 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void RpcInterruptionPoint

(

)

Throw JSONRPCError if RPC is not running.

Definition at line 320 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool RPCIsInWarmup

(

std::string *

outStatus

)

Definition at line 338 of file server.cpp.

Here is the caller graph for this function:

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

Run func nSeconds from now.

Overrides previous timer <name> (if any).

Definition at line 499 of file server.cpp.

Here is the call graph for this function:

int RPCSerializationFlags

(

)

Definition at line 509 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void RPCSetTimerInterface

(

RPCTimerInterface *

iface

)

Set the factory function for timers.

Definition at line 488 of file server.cpp.

Here is the caller graph for this function:

void RPCSetTimerInterfaceIfUnset

(

RPCTimerInterface *

iface

)

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

Definition at line 482 of file server.cpp.

void RPCUnsetTimerInterface

(

RPCTimerInterface *

iface

)

Unset factory function for timers.

Definition at line 493 of file server.cpp.

Here is the caller graph for this function:

void SetRPCWarmupFinished

(

)

Definition at line 331 of file server.cpp.

Here is the caller graph for this function:

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.

Definition at line 325 of file server.cpp.

Here is the caller graph for this function:

void StartRPC

(

)

Definition at line 284 of file server.cpp.

Here is the caller graph for this function:

static RPCHelpMan stop ( )

static

Definition at line 155 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void StopRPC

(

)

Definition at line 302 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Definition at line 389 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

static RPCHelpMan uptime ( )

static

Definition at line 181 of file server.cpp.

Here is the call graph for this function:

Variable Documentation

Mutex g_deadline_timers_mutex

static

Definition at line 30 of file server.cpp.

std::atomic<bool> g_rpc_running {false}

static

Definition at line 24 of file server.cpp.

RPCServerInfo g_rpc_server_info

static

Definition at line 46 of file server.cpp.

Mutex g_rpc_warmup_mutex

static

Definition at line 23 of file server.cpp.

struct CRPCSignals g_rpcSignals

static

CRPCTable tableRPC

Definition at line 517 of file server.cpp.

RPCTimerInterface* timerInterface = nullptr

static

Definition at line 28 of file server.cpp.

const CRPCCommand vRPCCommands[]

static

Initial value:

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

Definition at line 246 of file server.cpp.