Represents a JSON RPC request. More...

#include <request.h>

Collaboration diagram for wwa::json_rpc::jsonrpc_request:

Static Public Member Functions
static jsonrpc_request	from_json (const nlohmann::json &request)
	Parses and validates a JSON RPC request.

Public Attributes
nlohmann::json	extra
	Extra fields from the JSON RPC request.

nlohmann::json	id
	The ID of the request.

std::string	jsonrpc
	The JSON RPC version.

std::string	method
	The name of the method to be invoked.

nlohmann::json	params
	The parameters for the method.

Detailed Description

Represents a JSON RPC request.

This struct holds the components of a JSON RPC request, including the JSON RPC version, method name, parameters, and ID.

See also: https://www.jsonrpc.org/specification#request_object

Definition at line 22 of file request.h.

Member Function Documentation

◆ from_json()

jsonrpc_request wwa::json_rpc::jsonrpc_request::from_json ( const nlohmann::json & request )

static

Parses and validates a JSON RPC request.

Parameters

request The JSON RPC request as a nlohmann::json object.

Returns: The parsed JSON RPC request.

This method extracts the components of a JSON RPC request from the provided JSON object and validates the request, ensuring that all required fields are present and correctly formatted.

Exceptions

exception If the request is invalid.

See also: exception::INVALID_REQUEST, exception::INVALID_PARAMS

Definition at line 62 of file request.cpp.

{
    jsonrpc_request req;
    try {
        request.get_to(req);
    }
    catch (const nlohmann::json::exception&) {
        throw exception(exception::INVALID_REQUEST, err_bad_request);
    }
 
    if (req.jsonrpc != "2.0") {
        throw json_rpc::exception(json_rpc::exception::INVALID_REQUEST, json_rpc::err_not_jsonrpc_2_0_request);
    }
 
    if (!req.params.is_array()) {
        throw json_rpc::exception(json_rpc::exception::INVALID_PARAMS, json_rpc::err_bad_params_type);
    }
 
    if (req.method.empty()) {
        throw json_rpc::exception(json_rpc::exception::INVALID_REQUEST, json_rpc::err_empty_method);
    }
 
    if (!is_valid_request_id(req.id)) {
        throw json_rpc::exception(json_rpc::exception::INVALID_REQUEST, json_rpc::err_bad_id_type);
    }
 
    req.extra = request;
    req.extra.erase("jsonrpc");
    req.extra.erase("method");
    req.extra.erase("params");
    req.extra.erase("id");
    return req;
}

Member Data Documentation

◆ extra

nlohmann::json wwa::json_rpc::jsonrpc_request::extra

Extra fields from the JSON RPC request.

Definition at line 27 of file request.h.

◆ id

nlohmann::json wwa::json_rpc::jsonrpc_request::id

The ID of the request.

Definition at line 26 of file request.h.

◆ jsonrpc

std::string wwa::json_rpc::jsonrpc_request::jsonrpc

The JSON RPC version.

Definition at line 23 of file request.h.

◆ method

std::string wwa::json_rpc::jsonrpc_request::method

The name of the method to be invoked.

Definition at line 24 of file request.h.

◆ params

nlohmann::json wwa::json_rpc::jsonrpc_request::params

The parameters for the method.

Definition at line 25 of file request.h.

The documentation for this struct was generated from the following files:

Static Public Member Functions

Public Attributes