Bitcoin Core  0.18.99
P2P Digital Currency
Public Types | Public Member Functions | Public Attributes | List of all members
CRPCCommand Class Reference

#include <server.h>

Public Types

using Actor = std::function< bool(const JSONRPCRequest &request, UniValue &result, bool last_handler)>
 RPC method handler reading request and assigning result. More...
 

Public Member Functions

 CRPCCommand (std::string category, std::string name, Actor actor, std::vector< std::string > args, intptr_t unique_id)
 Constructor taking Actor callback supporting multiple handlers. More...
 
 CRPCCommand (const char *category, const char *name, rpcfn_type fn, std::initializer_list< const char *> args)
 Simplified constructor taking plain rpcfn_type function pointer. More...
 

Public Attributes

std::string category
 
std::string name
 
Actor actor
 
std::vector< std::string > argNames
 
intptr_t unique_id
 

Detailed Description

Definition at line 102 of file server.h.

Member Typedef Documentation

◆ Actor

using CRPCCommand::Actor = std::function<bool(const JSONRPCRequest& request, UniValue& result, bool last_handler)>

RPC method handler reading request and assigning result.

Should return true if request is fully handled, false if it should be passed on to subsequent handlers.

Definition at line 108 of file server.h.

Constructor & Destructor Documentation

◆ CRPCCommand() [1/2]

CRPCCommand::CRPCCommand ( std::string  category,
std::string  name,
Actor  actor,
std::vector< std::string >  args,
intptr_t  unique_id 
)
inline

Constructor taking Actor callback supporting multiple handlers.

Definition at line 111 of file server.h.

◆ CRPCCommand() [2/2]

CRPCCommand::CRPCCommand ( const char *  category,
const char *  name,
rpcfn_type  fn,
std::initializer_list< const char *>  args 
)
inline

Simplified constructor taking plain rpcfn_type function pointer.

Definition at line 118 of file server.h.

Member Data Documentation

◆ actor

Actor CRPCCommand::actor

Definition at line 127 of file server.h.

◆ argNames

std::vector<std::string> CRPCCommand::argNames

Definition at line 128 of file server.h.

◆ category

std::string CRPCCommand::category

Definition at line 125 of file server.h.

◆ name

std::string CRPCCommand::name

Definition at line 126 of file server.h.

◆ unique_id

intptr_t CRPCCommand::unique_id

Definition at line 129 of file server.h.


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