etl::LoadBalancerInterface Class Reference

An interface for LoadBalancer. More...

#include <LoadBalancerInterface.hpp>

Inheritance diagram for etl::LoadBalancerInterface:

Public Types
using	RawLedgerObjectType = org::xrpl::rpc::v1::RawLedgerObject
using	GetLedgerResponseType = org::xrpl::rpc::v1::GetLedgerResponse
using	OptionalGetLedgerResponseType = std::optional<GetLedgerResponseType>

Public Member Functions
virtual InitialLedgerLoadResult	loadInitialLedger (uint32_t sequence, InitialLoadObserverInterface &loader, std::chrono::steady_clock::duration retryAfter=std::chrono::seconds{2})=0
	Load the initial ledger, writing data to the queue.
virtual OptionalGetLedgerResponseType	fetchLedger (uint32_t ledgerSequence, bool getObjects, bool getObjectNeighbors, std::chrono::steady_clock::duration retryAfter=std::chrono::seconds{2})=0
	Fetch data for a specific ledger.
virtual boost::json::value	toJson () const =0
	Represent the state of this load balancer as a JSON object.
virtual std::expected< boost::json::object, rpc::CombinedError >	forwardToRippled (boost::json::object const &request, std::optional< std::string > const &clientIp, bool isAdmin, boost::asio::yield_context yield)=0
	Forward a JSON RPC request to a randomly selected rippled node.
virtual std::optional< ETLState >	getETLState () noexcept=0
	Return state of ETL nodes.
virtual void	stop (boost::asio::yield_context yield)=0
	Stop the load balancer. This will stop all subscription sources.

Detailed Description

An interface for LoadBalancer.

Member Function Documentation

fetchLedger()

virtual OptionalGetLedgerResponseType etl::LoadBalancerInterface::fetchLedger ( uint32_t ledgerSequence, bool getObjects, bool getObjectNeighbors, std::chrono::steady_clock::duration retryAfter = std::chrono::seconds{2} )

nodiscardpure virtual

Fetch data for a specific ledger.

This function will continuously try to fetch data for the specified ledger until the fetch succeeds, the ledger is found in the database, or the server is shutting down.

Parameters

ledgerSequence	Sequence of the ledger to fetch
getObjects	Whether to get the account state diff between this ledger and the prior one
getObjectNeighbors	Whether to request object neighbors
retryAfter	Time to wait between retries (2 seconds by default)

Returns

The extracted data, if extraction was successful. If the ledger was found in the database or the server is shutting down, the optional will be empty

Implemented in etl::LoadBalancer.

forwardToRippled()

virtual std::expected< boost::json::object, rpc::CombinedError > etl::LoadBalancerInterface::forwardToRippled ( boost::json::object const & request, std::optional< std::string > const & clientIp, bool isAdmin, boost::asio::yield_context yield )

nodiscardpure virtual

Forward a JSON RPC request to a randomly selected rippled node.

Parameters

request	JSON-RPC request to forward
clientIp	The IP address of the peer, if known
isAdmin	Whether the request is from an admin
yield	The coroutine context

Returns

Response received from rippled node as JSON object on success or error on failure

Implemented in etl::LoadBalancer.

getETLState()

virtual std::optional< ETLState > etl::LoadBalancerInterface::getETLState ( )

nodiscardpure virtualnoexcept

Return state of ETL nodes.

Returns

ETL state, nullopt if etl nodes not available

Implemented in etl::LoadBalancer.

loadInitialLedger()

virtual InitialLedgerLoadResult etl::LoadBalancerInterface::loadInitialLedger ( uint32_t sequence, InitialLoadObserverInterface & loader, std::chrono::steady_clock::duration retryAfter = std::chrono::seconds{2} )

nodiscardpure virtual

Load the initial ledger, writing data to the queue.

Note

This function will retry indefinitely until the ledger is downloaded or the download is cancelled.

Parameters

sequence	Sequence of ledger to download
loader	InitialLoadObserverInterface implementation
retryAfter	Time to wait between retries (2 seconds by default)

Returns

A std::expected with ledger edge keys on success, or InitialLedgerLoadError on failure

Implemented in etl::LoadBalancer.

stop()

virtual void etl::LoadBalancerInterface::stop ( boost::asio::yield_context yield )

pure virtual

Stop the load balancer. This will stop all subscription sources.

Note

This function will asynchronously wait for all sources to stop.

Parameters

yield

The coroutine context

Implemented in etl::LoadBalancer.

toJson()

virtual boost::json::value etl::LoadBalancerInterface::toJson ( ) const

nodiscardpure virtual

Represent the state of this load balancer as a JSON object.

Returns

JSON representation of the state of this load balancer.

Implemented in etl::LoadBalancer.

---

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

• /__w/clio/clio/src/etl/LoadBalancerInterface.hpp