A single registered RPC command together with its dispatch metadata.
Synopsis
Declared in <rpc/server.h>
class CRPCCommand;Type Aliases
Name |
Description |
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. |
Member Functions
Name |
Description |
|
Constructors |
Data Members
Name |
Description |
The handler callback that processes the request. |
|
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. |
|
The help category the command is grouped under. |
|
Factory for the method metadata, if any. |
|
The method name clients invoke. |
|
Identifier used to detect aliased commands. |
Non-Member Functions
Name |
Description |
Returns the RPC commands provided by the wallet component. |
Created with MrDocs