jsonrpc::client::Request Class Reference

Represents a JSON-RPC request. More...

#include <request.hpp>

Collaboration diagram for jsonrpc::client::Request:

Public Member Functions
	Request (std::string method, std::optional< nlohmann::json > params, bool is_notification, const std::function< int()> &id_generator)
	Constructs a new Request object.
auto	RequiresResponse () const -> bool
	Checks if the request requires a response.
auto	GetKey () const -> int
	Returns the unique key (ID) for the request.
auto	Dump () const -> std::string
	Serializes the request to a JSON string.

Detailed Description

Represents a JSON-RPC request.

This class handles the creation and management of JSON-RPC requests, including notifications (requests that do not expect a response).

Definition at line 17 of file request.hpp.

Constructor & Destructor Documentation

Request()

jsonrpc::client::Request::Request	(	std::string	method,
		std::optional< nlohmann::json >	params,
		bool	is_notification,
		const std::function< int()> &	id_generator )

Constructs a new Request object.

Parameters

method	The name of the method to be invoked.
params	Optional parameters to be passed with the request.
isNotification	True if this is a notification (no response expected).
idGenerator	A function to generate unique request IDs.

Definition at line 5 of file request.cpp.

    : method_(std::move(method)),
      params_(std::move(params)),
      is_notification_(is_notification),
      id_(0) {
  if (!is_notification_) {
    id_ = id_generator();
  }
}

Member Function Documentation

Dump()

auto jsonrpc::client::Request::Dump ( ) const -> std::string

nodiscard

Serializes the request to a JSON string.

Definition at line 25 of file request.cpp.

                                      {
  nlohmann::json json_request;
  json_request["jsonrpc"] = "2.0";
  json_request["method"] = method_;
  if (params_) {
    json_request["params"] = *params_;
  }
  if (!is_notification_) {
    json_request["id"] = id_;
  }
  return json_request.dump();
}

GetKey()

auto jsonrpc::client::Request::GetKey ( ) const -> int

nodiscard

Returns the unique key (ID) for the request.

Definition at line 21 of file request.cpp.

                                  {
  return id_;
}

RequiresResponse()

auto jsonrpc::client::Request::RequiresResponse ( ) const -> bool

nodiscard

Checks if the request requires a response.

Definition at line 17 of file request.cpp.

                                             {
  return !is_notification_;
}

---

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

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