server.h File Reference

#include <amount.h>
#include <rpc/protocol.h>
#include <uint256.h>
#include <list>
#include <map>
#include <stdint.h>
#include <string>
#include <univalue.h>

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
struct	UniValueType
	Wrapper for UniValue::VType, which includes typeAny: Used to denote don't care type. More...
class	JSONRPCRequest
class	RPCTimerBase
	Opaque base class for timers returned by NewTimerFunc. More...
class	RPCTimerInterface
	RPC timer "driver". More...
class	CRPCCommand
class	CRPCTable
	Bitcoin RPC command dispatcher. More...

Namespaces
	RPCServer

Typedefs
typedef UniValue(*	rpcfn_type) (const JSONRPCRequest &jsonRequest)

Functions
void	RPCServer::OnStarted (std::function< void()> slot)
void	RPCServer::OnStopped (std::function< void()> slot)
bool	IsRPCRunning ()
	Query whether RPC is running. More...
void	SetRPCWarmupStatus (const std::string &newStatus)
	Set the RPC warmup status. More...
void	SetRPCWarmupFinished ()
bool	RPCIsInWarmup (std::string *outStatus)
void	RPCTypeCheck (const UniValue &params, const std::list< UniValueType > &typesExpected, bool fAllowNull=false)
	Type-check arguments; throws JSONRPCError if wrong type given. More...
void	RPCTypeCheckArgument (const UniValue &value, const UniValueType &typeExpected)
	Type-check one argument; throws JSONRPCError if wrong type given. More...
void	RPCTypeCheckObj (const UniValue &o, const std::map< std::string, UniValueType > &typesExpected, bool fAllowNull=false, bool fStrict=false)
void	RPCSetTimerInterface (RPCTimerInterface *iface)
	Set the factory function for timers. More...
void	RPCSetTimerInterfaceIfUnset (RPCTimerInterface *iface)
	Set the factory function for timer, but only, if unset. 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...
bool	IsDeprecatedRPCEnabled (const std::string &method)
uint256	ParseHashV (const UniValue &v, std::string strName)
	Utilities: convert hex-encoded Values (throws error if not hex). More...
uint256	ParseHashO (const UniValue &o, std::string strKey)
std::vector< unsigned char >	ParseHexV (const UniValue &v, std::string strName)
std::vector< unsigned char >	ParseHexO (const UniValue &o, std::string strKey)
CAmount	AmountFromValue (const UniValue &value)
std::string	HelpExampleCli (const std::string &methodname, const std::string &args)
std::string	HelpExampleRpc (const std::string &methodname, const std::string &args)
void	StartRPC ()
void	InterruptRPC ()
void	StopRPC ()
std::string	JSONRPCExecBatch (const JSONRPCRequest &jreq, const UniValue &vReq)
int	RPCSerializationFlags ()

Variables
CRPCTable	tableRPC

Typedef Documentation

rpcfn_type

typedef UniValue(* rpcfn_type) (const JSONRPCRequest &jsonRequest)

Definition at line 129 of file server.h.

Function Documentation

AmountFromValue()

CAmount AmountFromValue

(

const UniValue &

value

)

Definition at line 105 of file server.cpp.

Here is the call graph for this function:

HelpExampleCli()

std::string HelpExampleCli	(	const std::string &	methodname,
		const std::string &	args
	)

Definition at line 511 of file server.cpp.

Here is the caller graph for this function:

HelpExampleRpc()

std::string HelpExampleRpc	(	const std::string &	methodname,
		const std::string &	args
	)

Definition at line 516 of file server.cpp.

Here is the caller graph for this function:

InterruptRPC()

void InterruptRPC

(

)

Definition at line 306 of file server.cpp.

Here is the caller graph for this function:

IsDeprecatedRPCEnabled()

bool IsDeprecatedRPCEnabled

(

const std::string &

method

)

Definition at line 380 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 321 of file server.cpp.

Here is the caller graph for this function:

JSONRPCExecBatch()

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

Definition at line 410 of file server.cpp.

Here is the call graph for this function:

ParseHashO()

uint256 ParseHashO	(	const UniValue &	o,
		std::string	strKey
	)

Definition at line 126 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ParseHashV()

uint256 ParseHashV	(	const UniValue &	v,
		std::string	strName
	)

Utilities: convert hex-encoded Values (throws error if not hex).

Definition at line 117 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ParseHexO()

std::vector<unsigned char> ParseHexO	(	const UniValue &	o,
		std::string	strKey
	)

Definition at line 139 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ParseHexV()

std::vector<unsigned char> ParseHexV	(	const UniValue &	v,
		std::string	strName
	)

Definition at line 130 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

)

Definition at line 339 of file server.cpp.

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 539 of file server.cpp.

RPCSerializationFlags()

int RPCSerializationFlags

(

)

Definition at line 548 of file server.cpp.

Here is the call graph for this function:

RPCSetTimerInterface()

void RPCSetTimerInterface

(

RPCTimerInterface *

iface

)

Set the factory function for timers.

Definition at line 528 of file server.cpp.

RPCSetTimerInterfaceIfUnset()

void RPCSetTimerInterfaceIfUnset

(

RPCTimerInterface *

iface

)

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

Definition at line 522 of file server.cpp.

RPCTypeCheck()

void RPCTypeCheck	(	const UniValue &	params,
		const std::list< UniValueType > &	typesExpected,
		bool	fAllowNull = false
	)

Type-check arguments; throws JSONRPCError if wrong type given.

Does not check that the right number of arguments are passed, just that any passed are the correct type.

Definition at line 51 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

RPCTypeCheckArgument()

void RPCTypeCheckArgument	(	const UniValue &	value,
		const UniValueType &	typeExpected
	)

Type-check one argument; throws JSONRPCError if wrong type given.

Definition at line 68 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

RPCTypeCheckObj()

void RPCTypeCheckObj	(	const UniValue &	o,
		const std::map< std::string, UniValueType > &	typesExpected,
		bool	fAllowNull = false,
		bool	fStrict = false
	)

Definition at line 75 of file server.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

RPCUnsetTimerInterface()

void RPCUnsetTimerInterface

(

RPCTimerInterface *

iface

)

Unset factory function for timers.

Definition at line 533 of file server.cpp.

SetRPCWarmupFinished()

void SetRPCWarmupFinished

(

)

Definition at line 332 of file server.cpp.

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 326 of file server.cpp.

StartRPC()

void StartRPC

(

)

Definition at line 299 of file server.cpp.

StopRPC()

void StopRPC

(

)

Definition at line 313 of file server.cpp.

Variable Documentation

tableRPC

CRPCTable tableRPC

Definition at line 556 of file server.cpp.