jsonrpc::endpoint::Request Class Reference

#include <request.hpp>

Collaboration diagram for jsonrpc::endpoint::Request:

Public Member Functions
	Request (std::string method, std::optional< nlohmann::json > params, const std::function< RequestId()> &id_generator)
	Request (std::string method, std::optional< nlohmann::json > params, RequestId id)
	Request (std::string method, std::optional< nlohmann::json > params=std::nullopt)
auto	GetMethod () const -> const std::string &
auto	GetParams () const -> const std::optional< nlohmann::json > &
auto	IsNotification () const -> bool
auto	RequiresResponse () const -> bool
auto	GetId () const -> RequestId
auto	Dump () const -> std::string
auto	ToJson () const -> nlohmann::json

Static Public Member Functions
static auto	FromJson (const nlohmann::json &json_obj) -> std::expected< Request, error::RpcError >

Detailed Description

Definition at line 15 of file request.hpp.

Constructor & Destructor Documentation

Request() [1/3]

jsonrpc::endpoint::Request::Request	(	std::string	method,
		std::optional< nlohmann::json >	params,
		const std::function< RequestId()> &	id_generator )

Definition at line 8 of file request.cpp.

    : method_(std::move(method)),
      params_(std::move(params)),
      is_notification_(false),
      id_(id_generator()) {
}

Request() [2/3]

jsonrpc::endpoint::Request::Request	(	std::string	method,
		std::optional< nlohmann::json >	params,
		RequestId	id )

Definition at line 17 of file request.cpp.

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

Request() [3/3]

jsonrpc::endpoint::Request::Request ( std::string method, std::optional< nlohmann::json > params = std::nullopt )

explicit

Definition at line 25 of file request.cpp.

    : method_(std::move(method)),
      params_(std::move(params)),
      is_notification_(true) {  // No ID for notifications
}

Member Function Documentation

Dump()

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

nodiscard

FromJson()

auto jsonrpc::endpoint::Request::FromJson ( const nlohmann::json & json_obj ) -> std::expected<Request, error::RpcError>

static

Definition at line 31 of file request.cpp.

                                           {
  using error::RpcError;
  using error::RpcErrorCode;
 
  if (!json_obj.is_object()) {
    return RpcError::UnexpectedFromCode(
        RpcErrorCode::kInvalidRequest, "Request must be a JSON object");
  }
 
  if (!json_obj.contains("jsonrpc") ||
      (json_obj["jsonrpc"].get<std::string>() != kJsonRpcVersion)) {
    return RpcError::UnexpectedFromCode(
        RpcErrorCode::kInvalidRequest, "Missing or invalid 'jsonrpc' version");
  }
 
  if (!json_obj.contains("method") || !json_obj["method"].is_string()) {
    return RpcError::UnexpectedFromCode(
        RpcErrorCode::kInvalidRequest, "Missing or invalid 'method'");
  }
 
  auto method = json_obj["method"].get<std::string>();
  auto params = json_obj.contains("params")
                    ? std::optional<nlohmann::json>(json_obj["params"])
                    : std::nullopt;
 
  if (json_obj.contains("params")) {
    const auto& p = json_obj["params"];
    if (!p.is_array() && !p.is_object() && !p.is_null()) {
      return RpcError::UnexpectedFromCode(
          RpcErrorCode::kInvalidRequest,
          "'params' must be object, array, or null");
    }
  }
 
  if (!json_obj.contains("id")) {
    return Request(std::move(method), std::move(params));  // Notification
  }
 
  const auto& id_json = json_obj["id"];
  if (!id_json.is_string() && !id_json.is_number_integer()) {
    return RpcError::UnexpectedFromCode(
        RpcErrorCode::kInvalidRequest, "Invalid 'id' type");
  }
 
  RequestId id;
  if (id_json.is_string()) {
    id = id_json.get<std::string>();
  } else {
    id = id_json.get<int64_t>();
  }
 
  return Request(std::move(method), std::move(params), std::move(id));
}

References jsonrpc::endpoint::kJsonRpcVersion, and jsonrpc::error::RpcError::UnexpectedFromCode().

Referenced by jsonrpc::endpoint::Dispatcher::DispatchRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

GetId()

auto jsonrpc::endpoint::Request::GetId ( ) const -> RequestId

nodiscard

Definition at line 90 of file request.cpp.

                                       {
  return id_;
}

GetMethod()

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

inlinenodiscard

Definition at line 30 of file request.hpp.

                                                           {
    return method_;
  }

GetParams()

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

inlinenodiscard

Definition at line 34 of file request.hpp.

                                                                           {
    return params_;
  }

IsNotification()

auto jsonrpc::endpoint::Request::IsNotification ( ) const -> bool

inlinenodiscard

Definition at line 38 of file request.hpp.

                                                    {
    return is_notification_;
  }

RequiresResponse()

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

nodiscard

Definition at line 86 of file request.cpp.

                                             {
  return !is_notification_;
}

ToJson()

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

nodiscard

Definition at line 94 of file request.cpp.

                                           {
  nlohmann::json json_obj;
  json_obj["jsonrpc"] = kJsonRpcVersion;
  json_obj["method"] = method_;
 
  if (params_.has_value()) {
    json_obj["params"] = params_.value();
  }
 
  if (!is_notification_) {
    if (std::holds_alternative<int64_t>(id_)) {
      json_obj["id"] = std::get<int64_t>(id_);
    } else {
      json_obj["id"] = std::get<std::string>(id_);
    }
  }
 
  return json_obj;
}

References jsonrpc::endpoint::kJsonRpcVersion.

Referenced by jsonrpc::endpoint::RpcEndpoint::SendMethodCall(), and jsonrpc::endpoint::RpcEndpoint::SendNotification().

Here is the caller graph for this function:

---

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

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