[#JSONRPCRequest]
= JSONRPCRequest
:mrdocs:

Context and parameters for a single JSON‐RPC request.

== Synopsis

Declared in `<rpc/request.h>`

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

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:JSONRPCRequest/Mode-08c.adoc[`Mode`] 
| How the request should be handled.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:JSONRPCRequest/IsNotification.adoc[`IsNotification`] 
| Report whether this request is a JSON‐RPC 2.0 notification.
| xref:JSONRPCRequest/parse.adoc[`parse`] 
| Parse a JSON‐RPC request object into this instance.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:JSONRPCRequest/URI.adoc[`URI`] 
| The transport URI the request arrived on.
| xref:JSONRPCRequest/authUser.adoc[`authUser`] 
| The authenticated user that made the request.
| xref:JSONRPCRequest/context.adoc[`context`] 
| Opaque per‐connection context passed to the method.
| xref:JSONRPCRequest/id.adoc[`id`] 
| The request id echoed back in the reply.
| xref:JSONRPCRequest/m_json_version.adoc[`m_json_version`] 
| The JSON‐RPC protocol version of the request.
| xref:JSONRPCRequest/mode-083.adoc[`mode`] 
| The handling mode for this request.
| xref:JSONRPCRequest/params.adoc[`params`] 
| The method parameters.
| xref:JSONRPCRequest/peerAddr.adoc[`peerAddr`] 
| The network address of the requesting peer.
| xref:JSONRPCRequest/strMethod.adoc[`strMethod`] 
| The requested RPC method name.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:JSONRPCExec.adoc[`JSONRPCExec`]
| Execute an RPC request and return its JSON‐RPC reply.
| xref:wallet/EnsureUniqueWalletName.adoc[`wallet::EnsureUniqueWalletName`]
| Ensures that a wallet name is specified across the endpoint and wallet_name. Throws `RPC_INVALID_PARAMETER` if none or different wallet names are specified.
| xref:wallet/GetWalletForJSONRPCRequest.adoc[`wallet::GetWalletForJSONRPCRequest`]
| Figures out what wallet, if any, to use for a JSONRPCRequest.
| xref:wallet/GetWalletNameFromJSONRPCRequest.adoc[`wallet::GetWalletNameFromJSONRPCRequest`]
| Extracts the wallet name encoded in a JSON‐RPC request endpoint, if any.
|===


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