server.h File Reference

#include <common/system.h>
#include <rpc/command.h>
#include <rpc/request.h>
#include <rpc/util.h>
#include <rwcollection.h>
#include <univalue.h>
#include <cstdint>
#include <functional>
#include <map>
#include <string>

Include dependency graph for server.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	RPCServer
	Class for registering and managing all RPC calls. More...
class	RPCTimerBase
	Opaque base class for timers returned by NewTimerFunc. More...
class	RPCTimerInterface
	RPC timer "driver". More...
class	CRPCCommand
class	CRPCTable
	RPC command dispatcher. More...

Namespaces
namespace	RPCServerSignals

Typedefs
typedef std::map< std::string, std::unique_ptr< RPCCommand > >	RPCCommandMap
using	RpcMethodFnType = RPCHelpMan(*)()

Functions
void	RPCServerSignals::OnStarted (std::function< void()> slot)
void	RPCServerSignals::OnStopped (std::function< void()> slot)
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.
void	RPCSetTimerInterface (RPCTimerInterface *iface)
	Set the factory function for timers.
void	RPCSetTimerInterfaceIfUnset (RPCTimerInterface *iface)
	Set the factory function for timer, but only, if unset.
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.
bool	IsDeprecatedRPCEnabled (const ArgsManager &args, const std::string &method)
void	StartRPC ()
void	InterruptRPC ()
void	StopRPC ()
std::string	JSONRPCExecBatch (const Config &config, RPCServer &rpcServer, const JSONRPCRequest &req, const UniValue &vReq)
int	RPCSerializationFlags ()
	Retrieves any serialization flags requested in command line argument.

Variables
static const unsigned int	DEFAULT_RPC_SERIALIZE_VERSION = 1
CRPCTable	tableRPC

Typedef Documentation

RPCCommandMap

typedef std::map<std::string, std::unique_ptr<RPCCommand> > RPCCommandMap

Definition at line 35 of file server.h.

RpcMethodFnType

using RpcMethodFnType = RPCHelpMan (*)()

Definition at line 145 of file server.h.

Function Documentation

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 &	req,
		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:

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:

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:

Variable Documentation

DEFAULT_RPC_SERIALIZE_VERSION

const unsigned int DEFAULT_RPC_SERIALIZE_VERSION = 1

static

Definition at line 23 of file server.h.

tableRPC

CRPCTable tableRPC

extern

Definition at line 683 of file server.cpp.