jsonrpc::server::Request Class Reference

Represents a JSON-RPC request. More...

#include <request.hpp>

Collaboration diagram for jsonrpc::server::Request:

Public Member Functions
	Request (std::string method, const std::optional< nlohmann::json > &params=std::nullopt, std::optional< nlohmann::json > id=std::nullopt)
	Constructs a Request object.
auto	ToJson () const -> nlohmann::json
	Serializes the Request object to a JSON object.
auto	GetMethod () const -> std::string
	Gets the method name.
auto	GetParams () const -> std::optional< nlohmann::json >
	Gets the parameters.
auto	GetId () const -> std::optional< nlohmann::json >
	Gets the request ID.

Static Public Member Functions
static auto	FromJson (const nlohmann::json &json_obj) -> Request
	Creates a Request object from a JSON object.

Detailed Description

Represents a JSON-RPC request.

Definition at line 13 of file request.hpp.

Constructor & Destructor Documentation

Request()

jsonrpc::server::Request::Request ( std::string method, const std::optional< nlohmann::json > & params = std::nullopt, std::optional< nlohmann::json > id = std::nullopt )

explicit

Constructs a Request object.

Parameters

method	The name of the method to be invoked.
params	The parameters for the method (optional).
id	The ID of the request (optional).

Definition at line 5 of file request.cpp.

    : method_(std::move(method)), params_(params), id_(std::move(id)) {
}

Member Function Documentation

FromJson()

auto jsonrpc::server::Request::FromJson ( const nlohmann::json & json_obj ) -> Request

static

Creates a Request object from a JSON object.

Parameters

jsonObj

The JSON object representing the request.

Returns

A Request object.

Definition at line 11 of file request.cpp.

                                                              {
  auto params = json_obj.contains("params")
                    ? std::optional<nlohmann::json>(json_obj["params"])
                    : std::nullopt;
 
  auto id = json_obj.contains("id")
                ? std::optional<nlohmann::json>(json_obj["id"])
                : std::nullopt;
  return Request(json_obj["method"], params, id);
}

GetId()

auto jsonrpc::server::Request::GetId ( ) const -> std::optional<nlohmann::json>

inlinenodiscard

Gets the request ID.

Definition at line 53 of file request.hpp.

                                                                {
    return id_;
  }

GetMethod()

auto jsonrpc::server::Request::GetMethod ( ) const -> std::string

inlinenodiscard

Gets the method name.

Definition at line 43 of file request.hpp.

                                                    {
    return method_;
  }

GetParams()

auto jsonrpc::server::Request::GetParams ( ) const -> std::optional<nlohmann::json>

inlinenodiscard

Gets the parameters.

Definition at line 48 of file request.hpp.

                                                                    {
    return params_;
  }

ToJson()

auto jsonrpc::server::Request::ToJson ( ) const -> nlohmann::json

nodiscard

Serializes the Request object to a JSON object.

Returns

The JSON representation of the request.

Definition at line 22 of file request.cpp.

                                           {
  nlohmann::json json_obj;
  json_obj["jsonrpc"] = "2.0";
  json_obj["method"] = method_;
  if (params_.has_value()) {
    json_obj["params"] = params_.value();
  }
  if (id_.has_value()) {
    json_obj["id"] = id_.value();
  }
  return json_obj;
}

---

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

• include/jsonrpc/server/request.hpp
• src/server/request.cpp