rpc::RPCEngine< CountersType > Class Template Reference

The RPC engine that ties all RPC-related functionality together. More...

#include <RPCEngine.hpp>

Public Member Functions
	RPCEngine (util::config::ClioConfigDefinition const &config, std::shared_ptr< BackendInterface > const &backend, std::shared_ptr< etlng::LoadBalancerInterface > const &balancer, web::dosguard::DOSGuardInterface const &dosGuard, WorkQueue &workQueue, CountersType &counters, std::shared_ptr< HandlerProvider const > const &handlerProvider)
	Construct a new RPCEngine object.
Result	buildResponse (web::Context const &ctx)
	Main request processor routine.
template<typename FnType >
bool	post (FnType &&func, std::string const &ip)
	Used to schedule request processing onto the work queue.
void	notifyComplete (std::string const &method, std::chrono::microseconds const &duration)
	Notify the system that specified method was executed.
void	notifyFailed (std::string const &method)
	Notify the system that specified method failed to execute due to a recoverable user error.
void	notifyErrored (std::string const &method)
	Notify the system that specified method failed due to some unrecoverable error.
void	notifyTooBusy ()
	Notify the system that the RPC system is too busy to handle an incoming request.
void	notifyNotReady ()
	Notify the system that the RPC system was not ready to handle an incoming request.
void	notifyBadSyntax ()
	Notify the system that the incoming request did not specify the RPC method/command.
void	notifyUnknownCommand ()
	Notify the system that the incoming request specified an unknown/unsupported method/command.
void	notifyInternalError ()
	Notify the system that the incoming request lead to an internal error (unrecoverable).

Static Public Member Functions
static std::shared_ptr< RPCEngine >	makeRPCEngine (util::config::ClioConfigDefinition const &config, std::shared_ptr< BackendInterface > const &backend, std::shared_ptr< etlng::LoadBalancerInterface > const &balancer, web::dosguard::DOSGuardInterface const &dosGuard, WorkQueue &workQueue, CountersType &counters, std::shared_ptr< HandlerProvider const > const &handlerProvider)
	Factory function to create a new instance of the RPC engine.

Detailed Description

template<typename CountersType>
class rpc::RPCEngine< CountersType >

The RPC engine that ties all RPC-related functionality together.

Constructor & Destructor Documentation

RPCEngine()

template<typename CountersType >

rpc::RPCEngine< CountersType >::RPCEngine ( util::config::ClioConfigDefinition const & config, std::shared_ptr< BackendInterface > const & backend, std::shared_ptr< etlng::LoadBalancerInterface > const & balancer, web::dosguard::DOSGuardInterface const & dosGuard, WorkQueue & workQueue, CountersType & counters, std::shared_ptr< HandlerProvider const > const & handlerProvider )

inline

Construct a new RPCEngine object.

Parameters

config	The config to use
backend	The backend to use
balancer	The load balancer to use
dosGuard	The DOS guard to use
workQueue	The work queue to use
counters	The counters to use
handlerProvider	The handler provider to use

Member Function Documentation

buildResponse()

template<typename CountersType >

Result rpc::RPCEngine< CountersType >::buildResponse ( web::Context const & ctx )

inline

Main request processor routine.

Parameters

ctx	The Context of the request

Returns

A result which can be an error status or a valid JSON response

makeRPCEngine()

template<typename CountersType >

static std::shared_ptr< RPCEngine > rpc::RPCEngine< CountersType >::makeRPCEngine ( util::config::ClioConfigDefinition const & config, std::shared_ptr< BackendInterface > const & backend, std::shared_ptr< etlng::LoadBalancerInterface > const & balancer, web::dosguard::DOSGuardInterface const & dosGuard, WorkQueue & workQueue, CountersType & counters, std::shared_ptr< HandlerProvider const > const & handlerProvider )

inlinestatic

Factory function to create a new instance of the RPC engine.

Parameters

config	The config to use
backend	The backend to use
balancer	The load balancer to use
dosGuard	The DOS guard to use
workQueue	The work queue to use
counters	The counters to use
handlerProvider	The handler provider to use

Returns

A new instance of the RPC engine

notifyComplete()

template<typename CountersType >

void rpc::RPCEngine< CountersType >::notifyComplete ( std::string const & method, std::chrono::microseconds const & duration )

inline

Notify the system that specified method was executed.

Parameters

method
duration	The time it took to execute the method specified in microseconds

notifyErrored()

template<typename CountersType >

void rpc::RPCEngine< CountersType >::notifyErrored ( std::string const & method )

inline

Notify the system that specified method failed due to some unrecoverable error.

Used for erors such as database timeout, internal errors, etc.

Parameters

method

notifyFailed()

template<typename CountersType >

void rpc::RPCEngine< CountersType >::notifyFailed ( std::string const & method )

inline

Notify the system that specified method failed to execute due to a recoverable user error.

Used for errors based on user input, not actual failures of the db or clio itself.

Parameters

method

notifyNotReady()

template<typename CountersType >

void rpc::RPCEngine< CountersType >::notifyNotReady ( )

inline

Notify the system that the RPC system was not ready to handle an incoming request.

This happens when the backend is not yet have a ledger range

post()

template<typename CountersType >

template<typename FnType >

bool rpc::RPCEngine< CountersType >::post ( FnType && func, std::string const & ip )

inline

Used to schedule request processing onto the work queue.

Template Parameters

FnType

The type of function

Parameters

func	The lambda to execute when this request is handled
ip	The ip address for which this request is being executed

Returns

true if the request was successfully scheduled; false otherwise

---

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

• /__w/clio/clio/src/rpc/RPCEngine.hpp