server.cpp File Reference

#include <rpc/server.h>
#include <common/args.h>
#include <config.h>
#include <logging.h>
#include <rpc/util.h>
#include <shutdown.h>
#include <sync.h>
#include <util/strencodings.h>
#include <util/string.h>
#include <util/time.h>
#include <boost/signals2/signal.hpp>
#include <cassert>
#include <chrono>
#include <memory>
#include <mutex>
#include <set>
#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

Typedefs
using	SteadyClock = std::chrono::steady_clock

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 Config &config, 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.
void	RpcInterruptionPoint ()
	Throw JSONRPCError if RPC is not running.
void	SetRPCWarmupStatus (const std::string &newStatus)
	Set the RPC warmup status.
void	SetRPCWarmupFinished ()
	Mark warmup as done.
bool	RPCIsInWarmup (std::string *outStatus)
	Returns the current warmup state.
bool	IsDeprecatedRPCEnabled (const ArgsManager &args, const std::string &method)
static UniValue	JSONRPCExecOne (const Config &config, RPCServer &rpcServer, JSONRPCRequest jreq, const UniValue &req)
std::string	JSONRPCExecBatch (const Config &config, RPCServer &rpcServer, const JSONRPCRequest &jreq, const UniValue &vReq)
static JSONRPCRequest	transformNamedArguments (const JSONRPCRequest &in, const std::vector< std::pair< std::string, bool > > &argNames)
	Process named arguments into a vector of positional arguments, based on the passed-in specification for the RPC call's arguments.
static bool	ExecuteCommands (const Config &config, const std::vector< const CRPCCommand * > &commands, const JSONRPCRequest &request, UniValue &result)
void	RPCSetTimerInterfaceIfUnset (RPCTimerInterface *iface)
	Set the factory function for timer, but only, if unset.
void	RPCSetTimerInterface (RPCTimerInterface *iface)
	Set the factory function for timers.
void	RPCUnsetTimerInterface (RPCTimerInterface *iface)
	Unset factory function for timers.
void	RPCRunLater (const std::string &name, std::function< void()> func, int64_t nSeconds)
	Run func nSeconds from now.
int	RPCSerializationFlags ()
	Retrieves any serialization flags requested in command line argument.

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

Typedef Documentation

SteadyClock

using SteadyClock = std::chrono::steady_clock

Definition at line 28 of file server.cpp.

Function Documentation

ExecuteCommand()

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

static

Definition at line 603 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ExecuteCommands()

static bool ExecuteCommands ( const Config &  config, const std::vector< const CRPCCommand * > &  commands, const JSONRPCRequest &  request, UniValue &  result  )

static

Definition at line 570 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getrpcinfo()

static RPCHelpMan getrpcinfo ( )

static

Definition at line 255 of file server.cpp.

Here is the call graph for this function:

GUARDED_BY() [1/2]

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

static

GUARDED_BY() [2/2]

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

static

help()

static RPCHelpMan help ( )

static

Definition at line 182 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

InterruptRPC()

void InterruptRPC

(

)

Definition at line 354 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

IsDeprecatedRPCEnabled()

bool IsDeprecatedRPCEnabled	(	const ArgsManager &	args,
		const std::string &	method
	)

Definition at line 407 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

IsRPCRunning()

bool IsRPCRunning

(

)

Query whether RPC is running.

Definition at line 378 of file server.cpp.

Here is the caller graph for this function:

JSONRPCExecBatch()

std::string JSONRPCExecBatch	(	const Config &	config,
		RPCServer &	rpcServer,
		const JSONRPCRequest &	jreq,
		const UniValue &	vReq
	)

Definition at line 435 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

JSONRPCExecOne()

static UniValue JSONRPCExecOne ( const Config &  config, RPCServer &  rpcServer, JSONRPCRequest  jreq, const UniValue &  req  )

static

Definition at line 416 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

RpcInterruptionPoint()

void RpcInterruptionPoint

(

)

Throw JSONRPCError if RPC is not running.

Definition at line 382 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

RPCIsInWarmup()

bool RPCIsInWarmup

(

std::string *

outStatus

)

Returns the current warmup state.

Definition at line 399 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

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).

Definition at line 664 of file server.cpp.

Here is the call graph for this function:

RPCSerializationFlags()

int RPCSerializationFlags

(

)

Retrieves any serialization flags requested in command line argument.

Definition at line 679 of file server.cpp.

Here is the caller graph for this function:

RPCSetTimerInterface()

void RPCSetTimerInterface

(

RPCTimerInterface *

iface

)

Set the factory function for timers.

Definition at line 654 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

RPCSetTimerInterfaceIfUnset()

void RPCSetTimerInterfaceIfUnset

(

RPCTimerInterface *

iface

)

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

Definition at line 648 of file server.cpp.

Here is the call graph for this function:

RPCUnsetTimerInterface()

void RPCUnsetTimerInterface

(

RPCTimerInterface *

iface

)

Unset factory function for timers.

Definition at line 658 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

SetRPCWarmupFinished()

void SetRPCWarmupFinished

(

)

Mark warmup as done.

RPC calls will be processed from now on.

Definition at line 393 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Definition at line 388 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

StartRPC()

void StartRPC

(

)

Definition at line 348 of file server.cpp.

Here is the caller graph for this function:

stop()

static RPCHelpMan stop ( )

static

Definition at line 211 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

StopRPC()

void StopRPC

(

)

Definition at line 365 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

transformNamedArguments()

static JSONRPCRequest transformNamedArguments ( const JSONRPCRequest &  in, const std::vector< std::pair< std::string, bool > > &  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 449 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

uptime()

static RPCHelpMan uptime ( )

static

Definition at line 240 of file server.cpp.

Here is the call graph for this function:

Variable Documentation

g_deadline_timers_mutex

GlobalMutex g_deadline_timers_mutex

static

Definition at line 38 of file server.cpp.

g_rpc_running

std::atomic<bool> g_rpc_running {false}

static

Definition at line 31 of file server.cpp.

g_rpc_server_info

RPCServerInfo g_rpc_server_info

static

Definition at line 55 of file server.cpp.

g_rpc_warmup_mutex

GlobalMutex g_rpc_warmup_mutex

static

Definition at line 30 of file server.cpp.

g_rpcSignals

struct CRPCSignals g_rpcSignals

static

tableRPC

CRPCTable tableRPC

Definition at line 683 of file server.cpp.

timerInterface

RPCTimerInterface* timerInterface = nullptr

static

Definition at line 36 of file server.cpp.

vRPCCommands

const CRPCCommand vRPCCommands[]

static

Initial value:

= {
    
    
    
    { "control",             getrpcinfo,           },
    { "control",             help,                 },
    { "control",             stop,                 },
    { "control",             uptime,               },
}

Definition at line 310 of file server.cpp.