Bitcoin ABC  0.24.10
P2P Digital Currency
Public Member Functions | Private Attributes | List of all members
RPCCommand Class Referenceabstract

Base class for all RPC commands. More...

#include <command.h>

Inheritance diagram for RPCCommand:
[legend]

Public Member Functions

 RPCCommand (const std::string &nameIn)
 
virtual ~RPCCommand ()
 
 RPCCommand (const RPCCommand &)=delete
 
RPCCommandoperator= (const RPCCommand &)=delete
 
virtual UniValue Execute (const JSONRPCRequest &request) const =0
 It is recommended to override Execute(JSONRPCRequest) only if the entire request context is required. More...
 
const std::string & GetName () const
 

Private Attributes

const std::string name
 

Detailed Description

Base class for all RPC commands.

RPCCommand should only be inherited from directly if access to the entire request context is necessary. For more typical cases where only request arguments are required, see the RPCCommandWithArgsContext class.

Definition at line 20 of file command.h.

Constructor & Destructor Documentation

◆ RPCCommand() [1/2]

RPCCommand::RPCCommand ( const std::string &  nameIn)
inline

Definition at line 34 of file command.h.

◆ ~RPCCommand()

virtual RPCCommand::~RPCCommand ( )
inlinevirtual

Definition at line 35 of file command.h.

◆ RPCCommand() [2/2]

RPCCommand::RPCCommand ( const RPCCommand )
delete

Member Function Documentation

◆ Execute()

virtual UniValue RPCCommand::Execute ( const JSONRPCRequest request) const
pure virtual

It is recommended to override Execute(JSONRPCRequest) only if the entire request context is required.

Otherwise, use RPCCommandWithArgsContext instead.

Implemented in RPCCommandWithArgsContext.

◆ GetName()

const std::string& RPCCommand::GetName ( ) const
inline

Definition at line 47 of file command.h.

◆ operator=()

RPCCommand& RPCCommand::operator= ( const RPCCommand )
delete

Member Data Documentation

◆ name

const std::string RPCCommand::name
private

Definition at line 22 of file command.h.


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