jsonrpc::endpoint::PendingRequest Class Reference

A class representing a pending RPC request. More...

#include <pending_request.hpp>

Collaboration diagram for jsonrpc::endpoint::PendingRequest:

Public Member Functions
	PendingRequest (asio::strand< asio::any_io_executor > strand)
	Construct a new Pending Request object.
	PendingRequest (const PendingRequest &)=delete
auto	operator= (const PendingRequest &) -> PendingRequest &=delete
	PendingRequest (PendingRequest &&)=delete
auto	operator= (PendingRequest &&) -> PendingRequest &=delete
	~PendingRequest ()=default
	Destructor.
void	SetResult (nlohmann::json result)
	Sets the result of the request.
void	Cancel (int code, const std::string &message)
	Cancels the request with an error.
auto	GetResult () -> asio::awaitable< nlohmann::json >
	Get the result asynchronously.
bool	IsReady () const
	Check if the request is ready.
bool	HasError () const
	Check if the request has an error.

Detailed Description

A class representing a pending RPC request.

This class provides an awaitable interface for RPC requests using ASIO's awaitable model directly.

Definition at line 17 of file pending_request.hpp.

Constructor & Destructor Documentation

PendingRequest() [1/3]

jsonrpc::endpoint::PendingRequest::PendingRequest ( asio::strand< asio::any_io_executor > strand )

inlineexplicit

Construct a new Pending Request object.

Parameters

strand

The strand to use for synchronization

Definition at line 24 of file pending_request.hpp.

      : strand_(std::move(strand)) {
  }

PendingRequest() [2/3]

jsonrpc::endpoint::PendingRequest::PendingRequest ( const PendingRequest & )

delete

PendingRequest() [3/3]

jsonrpc::endpoint::PendingRequest::PendingRequest ( PendingRequest && )

delete

~PendingRequest()

jsonrpc::endpoint::PendingRequest::~PendingRequest ( )

default

Destructor.

Member Function Documentation

Cancel()

void jsonrpc::endpoint::PendingRequest::Cancel ( int code, const std::string & message )

inline

Cancels the request with an error.

Parameters

code	The error code
message	The error message

Definition at line 64 of file pending_request.hpp.

                                                  {
    // Create a JSON-RPC error object
    nlohmann::json error = {{"error", {{"code", code}, {"message", message}}}};
 
    has_error_ = true;
 
    // Set the result with the error
    SetResult(std::move(error));
  }

References SetResult().

Here is the call graph for this function:

GetResult()

auto jsonrpc::endpoint::PendingRequest::GetResult ( ) -> asio::awaitable<nlohmann::json>

inline

Get the result asynchronously.

Returns

asio::awaitable<nlohmann::json> The result

Definition at line 79 of file pending_request.hpp.

                                                  {
    // If the result is already ready, return it immediately
    if (is_ready_) {
      co_return result_;
    }
 
    // Otherwise, wait for the result using a timer and polling
    // This is a simplified approach that works with ASIO
    auto executor = co_await asio::this_coro::executor;
    asio::steady_timer timer(executor, std::chrono::milliseconds(10));
 
    while (!is_ready_) {
      co_await timer.async_wait(asio::use_awaitable);
      timer.expires_after(std::chrono::milliseconds(10));
    }
 
    // Return the result
    co_return result_;
  }

HasError()

bool jsonrpc::endpoint::PendingRequest::HasError ( ) const

inlinenodiscard

Check if the request has an error.

Returns

true if the request has an error, false otherwise

Definition at line 113 of file pending_request.hpp.

                                      {
    return has_error_;
  }

IsReady()

bool jsonrpc::endpoint::PendingRequest::IsReady ( ) const

inlinenodiscard

Check if the request is ready.

Returns

true if the result is ready, false otherwise

Definition at line 104 of file pending_request.hpp.

                                     {
    return is_ready_;
  }

operator=() [1/2]

auto jsonrpc::endpoint::PendingRequest::operator= ( const PendingRequest & ) -> PendingRequest &=delete

delete

operator=() [2/2]

auto jsonrpc::endpoint::PendingRequest::operator= ( PendingRequest && ) -> PendingRequest &=delete

delete

SetResult()

void jsonrpc::endpoint::PendingRequest::SetResult ( nlohmann::json result )

inline

Sets the result of the request.

Parameters

result

The JSON result

Definition at line 44 of file pending_request.hpp.

                                      {
    // Execute within the strand to ensure thread safety
    asio::post(strand_, [this, result = std::move(result)]() mutable {
      if (!is_ready_) {
        result_ = std::move(result);
        is_ready_ = true;
 
        // Notify any waiting consumers
        std::lock_guard<std::mutex> lock(mutex_);
        ready_cv_.notify_all();
      }
    });
  }

Referenced by Cancel().

Here is the caller graph for this function:

---

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

• include/jsonrpc/endpoint/pending_request.hpp