Bitcoin Core  0.20.99
P2P Digital Currency
Public Types | Public Member Functions | Public Attributes | Private Attributes | List of all members
RPCHelpMan Class Reference

#include <util.h>

Collaboration diagram for RPCHelpMan:
[legend]

Public Types

using RPCMethodImpl = std::function< UniValue(const RPCHelpMan &, 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)
 
std::string ToString () const
 
UniValue HandleRequest (const JSONRPCRequest &request)
 
bool IsValidNumArgs (size_t num_args) const
 If the supplied number of args is neither too small nor too high. More...
 
void Check (const JSONRPCRequest &request) const
 Check if the given request is valid according to this command or if the user is asking for help information, and throw help when appropriate. More...
 
std::vector< std::string > GetArgNames () const
 

Public Attributes

const std::string m_name
 

Private Attributes

const RPCMethodImpl m_fun
 
const std::string m_description
 
const std::vector< RPCArgm_args
 
const RPCResults m_results
 
const RPCExamples m_examples
 

Detailed Description

Definition at line 332 of file util.h.

Member Typedef Documentation

◆ RPCMethodImpl

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

Definition at line 336 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 435 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 438 of file util.cpp.

Member Function Documentation

◆ Check()

void RPCHelpMan::Check ( const JSONRPCRequest request) const
inline

Check if the given request is valid according to this command or if the user is asking for help information, and throw help when appropriate.

Definition at line 351 of file util.h.

Here is the call graph for this function:

◆ GetArgNames()

std::vector< std::string > RPCHelpMan::GetArgNames ( ) const

Definition at line 490 of file util.cpp.

◆ HandleRequest()

UniValue RPCHelpMan::HandleRequest ( const JSONRPCRequest request)
inline

Definition at line 340 of file util.h.

◆ 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 478 of file util.cpp.

Here is the caller graph for this function:

◆ ToString()

std::string RPCHelpMan::ToString ( ) const

Definition at line 499 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 364 of file util.h.

◆ m_description

const std::string RPCHelpMan::m_description
private

Definition at line 363 of file util.h.

◆ m_examples

const RPCExamples RPCHelpMan::m_examples
private

Definition at line 366 of file util.h.

◆ m_fun

const RPCMethodImpl RPCHelpMan::m_fun
private

Definition at line 362 of file util.h.

◆ m_name

const std::string RPCHelpMan::m_name

Definition at line 359 of file util.h.

◆ m_results

const RPCResults RPCHelpMan::m_results
private

Definition at line 365 of file util.h.


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