Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
web::ng::RPCServerHandler< RPCEngineType > Class Template Reference

The server handler for RPC requests called by web server. More...

#include <RPCServerHandler.hpp>

Public Member Functions

 RPCServerHandler (util::config::ClioConfigDefinition const &config, std::shared_ptr< BackendInterface const > const &backend, std::shared_ptr< RPCEngineType > const &rpcEngine, std::shared_ptr< etlng::ETLServiceInterface const > const &etl, dosguard::DOSGuardInterface &dosguard)
 Create a new server handler.
 
Response operator() (Request const &request, ConnectionMetadata const &connectionMetadata, SubscriptionContextPtr subscriptionContext, boost::asio::yield_context yield)
 The callback when server receives a request.
 

Detailed Description

template<typename RPCEngineType>
class web::ng::RPCServerHandler< RPCEngineType >

The server handler for RPC requests called by web server.

Note: see web::SomeServerHandler concept

Constructor & Destructor Documentation

◆ RPCServerHandler()

template<typename RPCEngineType >
web::ng::RPCServerHandler< RPCEngineType >::RPCServerHandler ( util::config::ClioConfigDefinition const & config,
std::shared_ptr< BackendInterface const > const & backend,
std::shared_ptr< RPCEngineType > const & rpcEngine,
std::shared_ptr< etlng::ETLServiceInterface const > const & etl,
dosguard::DOSGuardInterface & dosguard )
inline

Create a new server handler.

Parameters
configClio config to use
backendThe backend to use
rpcEngineThe RPC engine to use
etlThe ETL to use
dosguardThe DOS guard service to use for request rate limiting

Member Function Documentation

◆ operator()()

template<typename RPCEngineType >
Response web::ng::RPCServerHandler< RPCEngineType >::operator() ( Request const & request,
ConnectionMetadata const & connectionMetadata,
SubscriptionContextPtr subscriptionContext,
boost::asio::yield_context yield )
inlinenodiscard

The callback when server receives a request.

Parameters
requestThe request
connectionMetadataThe connection metadata
subscriptionContextThe subscription context
yieldThe yield context
Returns
The response

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