Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
etlng::MonitorProviderInterface Struct Referenceabstract

An interface for providing Monitor instances. More...

#include <MonitorProviderInterface.hpp>

Inheritance diagram for etlng::MonitorProviderInterface:

Public Member Functions

virtual std::unique_ptr< MonitorInterfacemake (util::async::AnyExecutionContext ctx, std::shared_ptr< BackendInterface > backend, std::shared_ptr< etl::NetworkValidatedLedgersInterface > validatedLedgers, uint32_t startSequence, std::chrono::steady_clock::duration dbStalledReportDelay=kDEFAULT_DB_STALLED_REPORT_DELAY)=0
 Create a new Monitor instance.
 

Static Public Attributes

static constexpr auto kDEFAULT_DB_STALLED_REPORT_DELAY = std::chrono::seconds{10}
 The time Monitor should wait before reporting absence of updates to the database.
 

Detailed Description

An interface for providing Monitor instances.

Member Function Documentation

◆ make()

virtual std::unique_ptr< MonitorInterface > etlng::MonitorProviderInterface::make ( util::async::AnyExecutionContext ctx,
std::shared_ptr< BackendInterface > backend,
std::shared_ptr< etl::NetworkValidatedLedgersInterface > validatedLedgers,
uint32_t startSequence,
std::chrono::steady_clock::duration dbStalledReportDelay = kDEFAULT_DB_STALLED_REPORT_DELAY )
nodiscardpure virtual

Create a new Monitor instance.

Parameters
ctxThe execution context for asynchronous operations
backendInterface to the backend database
validatedLedgersInterface for accessing network validated ledgers
startSequenceThe sequence number to start monitoring from
dbStalledReportDelayThe timeout duration after which to signal no database updates
Returns
A unique pointer to a Monitor implementation

Implemented in etlng::impl::MonitorProvider.


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