RPCMethod

Describes an RPC method: its name, arguments, results, examples, and handler.

Synopsis

Declared in <rpc/util.h>

class RPCMethod;

Type Aliases

NameDescription
RPCMethodImpl The type of a function implementing an RPC method.

Member Functions

NameDescription
RPCMethod [constructor]Constructors
Arg Helper to get a required or default-valued request argument.
GetArgMap Return the named args that need to be converted from string to another JSON type
GetArgNames Return list of arguments and whether they are named-only.
GetArgs Return the method's arguments.
GetDescription Return the method description.
GetResults Return the method's results.
HandleRequest Validate the request and dispatch it to the method's implementation.
IsValidNumArgs If the supplied number of args is neither too small nor too high
MaybeArg Helper to get an optional request argument.
ToString Return the rendered help text for the method.

Data Members

NameDescription
m_name The method name.