#include <server.h>

Public Types
using	Actor = std::function< bool(const Config &config, 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::pair< std::string, bool >> _args, intptr_t _unique_id)
	Constructor taking Actor callback supporting multiple handlers. More...

	CRPCCommand (std::string _category, RpcMethodFnType _fn)
	Simplified constructor taking plain RpcMethodFnType function pointer. More...

Public Attributes
std::string	category

std::string	name

Actor	actor

std::vector< std::pair< std::string, bool > >	argNames
	List of method arguments and whether they are named-only. More...

intptr_t	unique_id

Detailed Description

Definition at line 147 of file server.h.

Member Typedef Documentation

◆ Actor

using CRPCCommand::Actor = std::function<bool(const Config &config, 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 152 of file server.h.

Constructor & Destructor Documentation

◆ CRPCCommand() [1/2]

CRPCCommand::CRPCCommand	(	std::string	_category,
		std::string	_name,
		Actor	_actor,
		std::vector< std::pair< std::string, bool >>	_args,
		intptr_t	_unique_id
	)

inline

Constructor taking Actor callback supporting multiple handlers.

Definition at line 157 of file server.h.

◆ CRPCCommand() [2/2]

CRPCCommand::CRPCCommand	(	std::string	_category,
		RpcMethodFnType	_fn
	)

inline

Simplified constructor taking plain RpcMethodFnType function pointer.

Definition at line 165 of file server.h.

Member Data Documentation

◆ actor

Actor CRPCCommand::actor

Definition at line 177 of file server.h.

◆ argNames

std::vector<std::pair<std::string, bool> > CRPCCommand::argNames

List of method arguments and whether they are named-only.

Incoming RPC requests contain a "params" field that can either be an array containing unnamed arguments or an object containing named arguments. The "argNames" vector is used in the latter case to transform the params object into an array. Each argument in "argNames" gets mapped to a unique position in the array, based on the order it is listed, unless the argument is a named-only argument with argNames[x].second set to true. Named-only arguments are combined into a JSON object that is appended after other arguments, see transformNamedArguments for details.

Definition at line 187 of file server.h.

◆ category

std::string CRPCCommand::category

Definition at line 175 of file server.h.

◆ name

std::string CRPCCommand::name

Definition at line 176 of file server.h.

◆ unique_id

intptr_t CRPCCommand::unique_id

Definition at line 188 of file server.h.

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

src/rpc/server.h

Public Types

Public Member Functions

Public Attributes