jsonrpc::endpoint::Response Class Reference

#include <response.hpp>

Collaboration diagram for jsonrpc::endpoint::Response:

Public Member Functions
	Response ()=default
	Response (const Response &)=default
	Response (Response &&other)=default
auto	operator= (const Response &) -> Response &=default
auto	operator= (Response &&other) noexcept -> Response &=default
	~Response ()=default
auto	IsSuccess () const -> bool
auto	GetResult () const -> const nlohmann::json &
auto	GetError () const -> const nlohmann::json &
auto	GetId () const -> std::optional< RequestId >
auto	ToJson () const -> nlohmann::json

Static Public Member Functions
static auto	FromJson (const nlohmann::json &json) -> std::expected< Response, error::RpcError >
static auto	CreateSuccess (const nlohmann::json &result, const std::optional< RequestId > &id) -> Response
static auto	CreateError (RpcErrorCode code, const std::optional< RequestId > &id=std::nullopt) -> Response
static auto	CreateError (const RpcError &error, const std::optional< RequestId > &id=std::nullopt) -> Response
static auto	CreateError (const nlohmann::json &error, const std::optional< RequestId > &id) -> Response

Detailed Description

Definition at line 16 of file response.hpp.

Constructor & Destructor Documentation

Response() [1/3]

jsonrpc::endpoint::Response::Response ( )

default

Response() [2/3]

jsonrpc::endpoint::Response::Response ( const Response & )

default

Response() [3/3]

jsonrpc::endpoint::Response::Response ( Response && other )

default

~Response()

jsonrpc::endpoint::Response::~Response ( )

default

Member Function Documentation

CreateError() [1/3]

auto jsonrpc::endpoint::Response::CreateError ( const nlohmann::json & error, const std::optional< RequestId > & id ) -> Response

static

Definition at line 49 of file response.cpp.

                {
  nlohmann::json response = {{"jsonrpc", kJsonRpcVersion}, {"error", error}};
  if (id) {
    std::visit([&response](const auto& v) { response["id"] = v; }, *id);
  }
  return Response{std::move(response)};
}

References jsonrpc::endpoint::kJsonRpcVersion.

CreateError() [2/3]

auto jsonrpc::endpoint::Response::CreateError ( const RpcError & error, const std::optional< RequestId > & id = std::nullopt ) -> Response

static

Definition at line 43 of file response.cpp.

                                                                         {
  nlohmann::json error_json = error.to_json();
  return CreateError(error_json, id);
}

CreateError() [3/3]

auto jsonrpc::endpoint::Response::CreateError ( RpcErrorCode code, const std::optional< RequestId > & id = std::nullopt ) -> Response

static

Definition at line 28 of file response.cpp.

                                                                     {
  RpcError err = RpcError::FromCode(code);
 
  nlohmann::json error = {
      {"code", static_cast<int>(err.Code())}, {"message", err.Message()}};
  nlohmann::json response = {{"jsonrpc", kJsonRpcVersion}, {"error", error}};
  if (id) {
    std::visit([&response](const auto& v) { response["id"] = v; }, *id);
  } else {
    response["id"] = nullptr;
  }
  return Response{std::move(response)};
}

References jsonrpc::error::RpcError::Code(), jsonrpc::error::RpcError::FromCode(), jsonrpc::endpoint::kJsonRpcVersion, and jsonrpc::error::RpcError::Message().

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

Here is the call graph for this function:

Here is the caller graph for this function:

CreateSuccess()

auto jsonrpc::endpoint::Response::CreateSuccess ( const nlohmann::json & result, const std::optional< RequestId > & id ) -> Response

static

Definition at line 18 of file response.cpp.

                {
  nlohmann::json response = {{"jsonrpc", kJsonRpcVersion}, {"result", result}};
  if (id) {
    std::visit([&response](const auto& v) { response["id"] = v; }, *id);
  }
  return Response{std::move(response)};
}

References jsonrpc::endpoint::kJsonRpcVersion.

FromJson()

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

static

Definition at line 9 of file response.cpp.

                                            {
  Response r{json};
  if (auto result = r.ValidateResponse(); !result) {
    return std::unexpected(result.error());
  }
  return r;
}

GetError()

auto jsonrpc::endpoint::Response::GetError ( ) const -> const nlohmann::json&

nodiscard

Definition at line 70 of file response.cpp.

                                                     {
  if (IsSuccess()) {
    throw std::runtime_error("Response is not an error response");
  }
  return response_["error"];
}

References IsSuccess().

Here is the call graph for this function:

GetId()

auto jsonrpc::endpoint::Response::GetId ( ) const -> std::optional<RequestId>

nodiscard

Definition at line 77 of file response.cpp.

                                                     {
  if (!response_.contains("id") || response_["id"].is_null()) {
    return std::nullopt;
  }
 
  const auto& id = response_["id"];
  if (id.is_string()) {
    return id.get<std::string>();
  }
  return id.get<int64_t>();
}

GetResult()

auto jsonrpc::endpoint::Response::GetResult ( ) const -> const nlohmann::json&

nodiscard

Definition at line 63 of file response.cpp.

                                                      {
  if (!IsSuccess()) {
    throw std::runtime_error("Response is not a success response");
  }
  return response_["result"];
}

References IsSuccess().

Here is the call graph for this function:

IsSuccess()

auto jsonrpc::endpoint::Response::IsSuccess ( ) const -> bool

nodiscard

Definition at line 59 of file response.cpp.

                                       {
  return response_.contains("result");
}

Referenced by GetError(), and GetResult().

Here is the caller graph for this function:

operator=() [1/2]

auto jsonrpc::endpoint::Response::operator= ( const Response & ) -> Response &=default

default

operator=() [2/2]

auto jsonrpc::endpoint::Response::operator= ( Response && other ) -> Response &=default

defaultnoexcept

ToJson()

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

nodiscard

Definition at line 89 of file response.cpp.

                                            {
  return response_;
}

Referenced by nlohmann::adl_serializer< jsonrpc::endpoint::Response >::to_json().

Here is the caller graph for this function:

---

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

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