RPCHelpMan Class Reference

#include <util.h>

Collaboration diagram for RPCHelpMan:

Public Types
using	RPCMethodImpl = std::function< UniValue(const RPCHelpMan &, const Config &config, const JSONRPCRequest &)>

Public Member Functions
	RPCHelpMan (std::string name, std::string description, std::vector< RPCArg > args, RPCResults results, RPCExamples examples)
	RPCHelpMan (std::string name, std::string description, std::vector< RPCArg > args, RPCResults results, RPCExamples examples, RPCMethodImpl fun)
UniValue	HandleRequest (const Config &config, const JSONRPCRequest &request) const
std::string	ToString () const
UniValue	GetArgMap () const
	Return the named args that need to be converted from string to another JSON type.
bool	IsValidNumArgs (size_t num_args) const
	If the supplied number of args is neither too small nor too high.
std::vector< std::pair< std::string, bool > >	GetArgNames () const
	Return list of arguments and whether they are named-only.

Public Attributes
const std::string	m_name

Private Attributes
const RPCMethodImpl	m_fun
const std::string	m_description
const std::vector< RPCArg >	m_args
const RPCResults	m_results
const RPCExamples	m_examples

Detailed Description

Definition at line 361 of file util.h.

Member Typedef Documentation

RPCMethodImpl

using RPCHelpMan::RPCMethodImpl = std::function<UniValue( const RPCHelpMan &, const Config &config, const JSONRPCRequest &)>

Definition at line 366 of file util.h.

Constructor & Destructor Documentation

RPCHelpMan() [1/2]

RPCHelpMan::RPCHelpMan	(	std::string	name,
		std::string	description,
		std::vector< RPCArg >	args,
		RPCResults	results,
		RPCExamples	examples
	)

Definition at line 487 of file util.cpp.

RPCHelpMan() [2/2]

RPCHelpMan::RPCHelpMan	(	std::string	name,
		std::string	description,
		std::vector< RPCArg >	args,
		RPCResults	results,
		RPCExamples	examples,
		RPCMethodImpl	fun
	)

Definition at line 493 of file util.cpp.

Here is the call graph for this function:

Member Function Documentation

GetArgMap()

UniValue RPCHelpMan::GetArgMap

(

)

const

Return the named args that need to be converted from string to another JSON type.

Definition at line 747 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GetArgNames()

std::vector< std::pair< std::string, bool > > RPCHelpMan::GetArgNames

(

)

const

Return list of arguments and whether they are named-only.

Definition at line 650 of file util.cpp.

Here is the call graph for this function:

HandleRequest()

UniValue RPCHelpMan::HandleRequest	(	const Config &	config,
		const JSONRPCRequest &	request
	)		const

Definition at line 587 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

IsValidNumArgs()

bool RPCHelpMan::IsValidNumArgs

(

size_t

num_args

)

const

If the supplied number of args is neither too small nor too high.

Definition at line 639 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ToString()

std::string RPCHelpMan::ToString

(

)

const

Definition at line 664 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_args

const std::vector<RPCArg> RPCHelpMan::m_args

private

Definition at line 390 of file util.h.

m_description

const std::string RPCHelpMan::m_description

private

Definition at line 389 of file util.h.

m_examples

const RPCExamples RPCHelpMan::m_examples

private

Definition at line 392 of file util.h.

m_fun

const RPCMethodImpl RPCHelpMan::m_fun

private

Definition at line 388 of file util.h.

m_name

const std::string RPCHelpMan::m_name

Definition at line 385 of file util.h.

m_results

const RPCResults RPCHelpMan::m_results

private

Definition at line 391 of file util.h.

---

The documentation for this class was generated from the following files:

• src/rpc/util.h
• src/rpc/util.cpp