[#CRPCCommand]
= CRPCCommand
:mrdocs:

A single registered RPC command together with its dispatch metadata&period;

== Synopsis

Declared in `&lt;rpc&sol;server&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class CRPCCommand;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:CRPCCommand/Actor-05.adoc[`Actor`] 
| RPC method handler reading request and assigning result&period; Should return true if request is fully handled, false if it should be passed on to subsequent handlers&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:CRPCCommand/2constructor-09.adoc[`CRPCCommand`]         [.small]#[constructor]#
| Constructors
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:CRPCCommand/actor-03.adoc[`actor`] 
| The handler callback that processes the request&period;
| xref:CRPCCommand/argNames.adoc[`argNames`] 
| List of method arguments and whether they are named&hyphen;only&period; Incoming RPC requests contain a &quot;params&quot; field that can either be an array containing unnamed arguments or an object containing named arguments&period; The &quot;argNames&quot; vector is used in the latter case to transform the params object into an array&period; Each argument in &quot;argNames&quot; gets mapped to a unique position in the array, based on the order it is listed, unless the argument is a named&hyphen;only argument with argNames&lsqb;x&rsqb;&period;second set to true&period; Named&hyphen;only arguments are combined into a JSON object that is appended after other arguments, see transformNamedArguments for details&period;
| xref:CRPCCommand/category.adoc[`category`] 
| The help category the command is grouped under&period;
| xref:CRPCCommand/metadata_fn.adoc[`metadata&lowbar;fn`] 
| Factory for the method metadata, if any&period;
| xref:CRPCCommand/name.adoc[`name`] 
| The method name clients invoke&period;
| xref:CRPCCommand/unique_id.adoc[`unique&lowbar;id`] 
| Identifier used to detect aliased commands&period;
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:wallet/GetWalletRPCCommands.adoc[`wallet&colon;&colon;GetWalletRPCCommands`]
| Returns the RPC commands provided by the wallet component&period;
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
