JSONRPCRequest

Context and parameters for a single JSON-RPC request.

Synopsis

Declared in <rpc/request.h>

class JSONRPCRequest;

Enums

NameDescription
Mode How the request should be handled.

Member Functions

NameDescription
IsNotification Report whether this request is a JSON-RPC 2.0 notification.
parse Parse a JSON-RPC request object into this instance.

Data Members

NameDescription
URI The transport URI the request arrived on.
authUser The authenticated user that made the request.
context Opaque per-connection context passed to the method.
id The request id echoed back in the reply.
m_json_version The JSON-RPC protocol version of the request.
mode The handling mode for this request.
params The method parameters.
peerAddr The network address of the requesting peer.
strMethod The requested RPC method name.

Non-Member Functions

NameDescription
JSONRPCExecExecute an RPC request and return its JSON-RPC reply.
wallet::EnsureUniqueWalletNameEnsures that a wallet name is specified across the endpoint and wallet_name. Throws RPC_INVALID_PARAMETER if none or different wallet names are specified.
wallet::GetWalletForJSONRPCRequestFigures out what wallet, if any, to use for a JSONRPCRequest.
wallet::GetWalletNameFromJSONRPCRequestExtracts the wallet name encoded in a JSON-RPC request endpoint, if any.