etl::NetworkValidatedLedgersInterface Class Reference

An interface for NetworkValidatedLedgers. More...

#include <NetworkValidatedLedgersInterface.hpp>

Inheritance diagram for etl::NetworkValidatedLedgersInterface:

Public Types
using	SignalType = boost::signals2::signal<void(uint32_t)>

Public Member Functions
virtual void	push (uint32_t idx)=0
	Notify the datastructure that idx has been validated by the network.
virtual std::optional< uint32_t >	getMostRecent ()=0
	Get most recently validated sequence.
virtual bool	waitUntilValidatedByNetwork (uint32_t sequence, std::optional< uint32_t > maxWaitMs={})=0
	Waits for the sequence to be validated by the network.
virtual boost::signals2::scoped_connection	subscribe (SignalType::slot_type const &subscriber)=0
	Allows clients to get notified when a new validated ledger becomes known to Clio.

Detailed Description

An interface for NetworkValidatedLedgers.

Member Function Documentation

getMostRecent()

virtual std::optional< uint32_t > etl::NetworkValidatedLedgersInterface::getMostRecent ( )

nodiscardpure virtual

Get most recently validated sequence.

If no ledgers are known to have been validated, this function waits until the next ledger is validated

Returns

Sequence of most recently validated ledger. empty optional if the datastructure has been stopped

Implemented in etl::NetworkValidatedLedgers.

push()

virtual void etl::NetworkValidatedLedgersInterface::push ( uint32_t idx )

pure virtual

Notify the datastructure that idx has been validated by the network.

Parameters

idx	Sequence validated by network

Implemented in etl::NetworkValidatedLedgers.

subscribe()

virtual boost::signals2::scoped_connection etl::NetworkValidatedLedgersInterface::subscribe ( SignalType::slot_type const & subscriber )

nodiscardpure virtual

Allows clients to get notified when a new validated ledger becomes known to Clio.

Parameters

subscriber

The slot to connect

Returns

A connection object that automatically disconnects the subscription once destroyed

Implemented in etl::NetworkValidatedLedgers.

waitUntilValidatedByNetwork()

virtual bool etl::NetworkValidatedLedgersInterface::waitUntilValidatedByNetwork ( uint32_t sequence, std::optional< uint32_t > maxWaitMs = {} )

pure virtual

Waits for the sequence to be validated by the network.

Parameters

sequence	The sequence to wait for
maxWaitMs	Maximum time to wait for the sequence to be validated. If empty, wait indefinitely

Returns

true if sequence was validated, false otherwise a return value of false means the datastructure has been stopped

Implemented in etl::NetworkValidatedLedgers.

---

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

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