Wraps a DigestAwareReadView to provide caching. More...

#include <CachedView.h>

Inheritance diagram for ripple::CachedView< Base >:

[legend]

Collaboration diagram for ripple::CachedView< Base >:

[legend]

Public Types
using	base_type = Base

using	digest_type = uint256

using	tx_type = std::pair< std::shared_ptr< STTx const >, std::shared_ptr< STObject const > >

using	key_type = uint256

using	mapped_type = std::shared_ptr< SLE const >

Public Member Functions
	CachedView ()=delete

	CachedView (CachedView const &)=delete

CachedView &	operator= (CachedView const &)=delete

	CachedView (std::shared_ptr< Base const > const &base, CachedSLEs &cache)

std::shared_ptr< Base const > const &	base () const
	Returns the base type.

bool	exists (Keylet const &k) const override
	Determine if a state item exists.

std::shared_ptr< SLE const >	read (Keylet const &k) const override
	Return the state item associated with a key.

bool	open () const override
	Returns true if this reflects an open ledger.

LedgerInfo const &	info () const override
	Returns information about the ledger.

Fees const &	fees () const override
	Returns the fees for the base ledger.

Rules const &	rules () const override
	Returns the tx processing rules.

std::optional< key_type >	succ (key_type const &key, std::optional< key_type > const &last=std::nullopt) const override
	Return the key of the next state item.

std::unique_ptr< sles_type::iter_base >	slesBegin () const override

std::unique_ptr< sles_type::iter_base >	slesEnd () const override

std::unique_ptr< sles_type::iter_base >	slesUpperBound (uint256 const &key) const override

virtual std::unique_ptr< sles_type::iter_base >	slesUpperBound (key_type const &key) const =0

std::unique_ptr< txs_type::iter_base >	txsBegin () const override

std::unique_ptr< txs_type::iter_base >	txsEnd () const override

bool	txExists (key_type const &key) const override
	Returns `true` if a tx exists in the tx map.

tx_type	txRead (key_type const &key) const override
	Read a transaction from the tx map.

std::optional< digest_type >	digest (key_type const &key) const override
	Return the digest associated with the key.

NetClock::time_point	parentCloseTime () const
	Returns the close time of the previous ledger.

LedgerIndex	seq () const
	Returns the sequence number of the base ledger.

virtual STAmount	balanceHook (AccountID const &account, AccountID const &issuer, STAmount const &amount) const

virtual std::uint32_t	ownerCountHook (AccountID const &account, std::uint32_t count) const

Public Attributes
sles_type	sles
	Iterable range of ledger state items.

txs_type	txs

Private Attributes
std::shared_ptr< Base const >	sp_

DigestAwareReadView const &	base_

CachedSLEs &	cache_

std::mutex	mutex_

std::unordered_map< key_type, uint256, hardened_hash<> >	map_

Detailed Description

template<class Base>
class ripple::CachedView< Base >

Wraps a DigestAwareReadView to provide caching.

Template Parameters

Base	A subclass of DigestAwareReadView

Definition at line 155 of file CachedView.h.

Member Typedef Documentation

◆ base_type

template<class Base >

using ripple::CachedView< Base >::base_type = Base

Definition at line 163 of file CachedView.h.

◆ digest_type

using ripple::DigestAwareReadView::digest_type = uint256

inherited

Definition at line 257 of file ReadView.h.

◆ tx_type

using ripple::ReadView::tx_type = std::pair<std::shared_ptr<STTx const>, std::shared_ptr<STObject const> >

inherited

Definition at line 53 of file ReadView.h.

◆ key_type

using ripple::ReadView::key_type = uint256

inherited

Definition at line 56 of file ReadView.h.

◆ mapped_type

using ripple::ReadView::mapped_type = std::shared_ptr<SLE const>

inherited

Definition at line 58 of file ReadView.h.

Constructor & Destructor Documentation

◆ CachedView() [1/3]

template<class Base >

ripple::CachedView< Base >::CachedView ( )

delete

◆ CachedView() [2/3]

template<class Base >

ripple::CachedView< Base >::CachedView ( CachedView< Base > const & )

delete

◆ CachedView() [3/3]

template<class Base >

ripple::CachedView< Base >::CachedView	(	std::shared_ptr< Base const > const &	base,
		CachedSLEs &	cache
	)

Definition at line 170 of file CachedView.h.

Member Function Documentation

◆ operator=()

template<class Base >

CachedView & ripple::CachedView< Base >::operator= ( CachedView< Base > const & )

delete

◆ base()

template<class Base >

std::shared_ptr< Base const > const & ripple::CachedView< Base >::base ( ) const

Returns the base type.

Note: This breaks encapsulation and bypasses the cache.

Definition at line 180 of file CachedView.h.

◆ exists()

bool ripple::detail::CachedViewImpl::exists ( Keylet const & k ) const

overridevirtualinherited

Determine if a state item exists.

Note: This can be more efficient than calling read.

Returns: true if a SLE is associated with the specified key.

Implements ripple::ReadView.

Definition at line 27 of file CachedView.cpp.

◆ read()

std::shared_ptr< SLE const > ripple::detail::CachedViewImpl::read ( Keylet const & k ) const

overridevirtualinherited

Return the state item associated with a key.

Effects: If the key exists, gives the caller ownership of the non-modifiable corresponding SLE.

Note: While the returned SLE is const from the perspective of the caller, it can be changed by other callers through raw operations.

Returns: nullptr if the key is not present or if the type does not match.

Implements ripple::ReadView.

Definition at line 33 of file CachedView.cpp.

◆ open()

bool ripple::detail::CachedViewImpl::open ( ) const

overridevirtualinherited

Returns true if this reflects an open ledger.

Implements ripple::ReadView.

Definition at line 64 of file CachedView.h.

◆ info()

LedgerInfo const & ripple::detail::CachedViewImpl::info ( ) const

overridevirtualinherited

Returns information about the ledger.

Implements ripple::ReadView.

Definition at line 70 of file CachedView.h.

◆ fees()

Fees const & ripple::detail::CachedViewImpl::fees ( ) const

overridevirtualinherited

Returns the fees for the base ledger.

Implements ripple::ReadView.

Definition at line 76 of file CachedView.h.

◆ rules()

Rules const & ripple::detail::CachedViewImpl::rules ( ) const

overridevirtualinherited

Returns the tx processing rules.

Implements ripple::ReadView.

Definition at line 82 of file CachedView.h.

◆ succ()

std::optional< key_type > ripple::detail::CachedViewImpl::succ	(	key_type const &	key,
		std::optional< key_type > const &	last = `std::nullopt`
	)		const

overridevirtualinherited

Return the key of the next state item.

This returns the key of the first state item whose key is greater than the specified key. If no such key is present, std::nullopt is returned.

If last is engaged, returns std::nullopt when the key returned would be outside the open interval (key, last).

Implements ripple::ReadView.

Definition at line 88 of file CachedView.h.

◆ slesBegin()

std::unique_ptr< sles_type::iter_base > ripple::detail::CachedViewImpl::slesBegin ( ) const

overridevirtualinherited

Implements ripple::ReadView.

Definition at line 96 of file CachedView.h.

◆ slesEnd()

std::unique_ptr< sles_type::iter_base > ripple::detail::CachedViewImpl::slesEnd ( ) const

overridevirtualinherited

Implements ripple::ReadView.

Definition at line 102 of file CachedView.h.

◆ slesUpperBound() [1/2]

std::unique_ptr< sles_type::iter_base > ripple::detail::CachedViewImpl::slesUpperBound ( uint256 const & key ) const

overrideinherited

Definition at line 108 of file CachedView.h.

◆ slesUpperBound() [2/2]

virtual std::unique_ptr< sles_type::iter_base > ripple::ReadView::slesUpperBound ( key_type const & key ) const

pure virtualinherited

◆ txsBegin()

std::unique_ptr< txs_type::iter_base > ripple::detail::CachedViewImpl::txsBegin ( ) const

overridevirtualinherited

Implements ripple::ReadView.

Definition at line 114 of file CachedView.h.

◆ txsEnd()

std::unique_ptr< txs_type::iter_base > ripple::detail::CachedViewImpl::txsEnd ( ) const

overridevirtualinherited

Implements ripple::ReadView.

Definition at line 120 of file CachedView.h.

◆ txExists()

bool ripple::detail::CachedViewImpl::txExists ( key_type const & key ) const

overridevirtualinherited

Returns true if a tx exists in the tx map.

A tx exists in the map if it is part of the base ledger, or if it is a newly inserted tx.

Implements ripple::ReadView.

Definition at line 126 of file CachedView.h.

◆ txRead()

tx_type ripple::detail::CachedViewImpl::txRead ( key_type const & key ) const

overridevirtualinherited

Read a transaction from the tx map.

If the view represents an open ledger, the metadata object will be empty.

Returns: A pair of nullptr if the key is not found in the tx map.

Implements ripple::ReadView.

Definition at line 132 of file CachedView.h.

◆ digest()

std::optional< digest_type > ripple::detail::CachedViewImpl::digest ( key_type const & key ) const

overridevirtualinherited

Return the digest associated with the key.

Returns: std::nullopt if the item does not exist.

Implements ripple::DigestAwareReadView.

Definition at line 142 of file CachedView.h.

◆ parentCloseTime()

NetClock::time_point ripple::ReadView::parentCloseTime ( ) const

inherited

Returns the close time of the previous ledger.

Definition at line 111 of file ReadView.h.

◆ seq()

LedgerIndex ripple::ReadView::seq ( ) const

inherited

Returns the sequence number of the base ledger.

Definition at line 118 of file ReadView.h.

◆ balanceHook()

virtual STAmount ripple::ReadView::balanceHook	(	AccountID const &	account,
		AccountID const &	issuer,
		STAmount const &	amount
	)		const

virtualinherited

Reimplemented in ripple::PaymentSandbox.

Definition at line 178 of file ReadView.h.

◆ ownerCountHook()

virtual std::uint32_t ripple::ReadView::ownerCountHook	(	AccountID const &	account,
		std::uint32_t	count
	)		const

virtualinherited

Reimplemented in ripple::PaymentSandbox.

Definition at line 192 of file ReadView.h.

Member Data Documentation

◆ sp_

template<class Base >

std::shared_ptr<Base const> ripple::CachedView< Base >::sp_

private

Definition at line 160 of file CachedView.h.

◆ base_

DigestAwareReadView const& ripple::detail::CachedViewImpl::base_

privateinherited

Definition at line 37 of file CachedView.h.

◆ cache_

CachedSLEs& ripple::detail::CachedViewImpl::cache_

privateinherited

Definition at line 38 of file CachedView.h.

◆ mutex_

std::mutex ripple::detail::CachedViewImpl::mutex_

mutableprivateinherited

Definition at line 39 of file CachedView.h.

◆ map_

std::unordered_map<key_type, uint256, hardened_hash<> > ripple::detail::CachedViewImpl::map_

mutableprivateinherited

Definition at line 40 of file CachedView.h.

◆ sles

sles_type ripple::ReadView::sles

inherited

Iterable range of ledger state items.

Note: Visiting each state entry in the ledger can become quite expensive as the ledger grows.

Definition at line 245 of file ReadView.h.

◆ txs

txs_type ripple::ReadView::txs

inherited

Definition at line 248 of file ReadView.h.

Public Types

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ base_type

◆ digest_type

◆ tx_type

◆ key_type

◆ mapped_type

Constructor & Destructor Documentation

◆ CachedView() [1/3]

◆ CachedView() [2/3]

◆ CachedView() [3/3]

Member Function Documentation

◆ operator=()

◆ base()

◆ exists()

◆ read()

◆ open()

◆ info()

◆ fees()

◆ rules()

◆ succ()

◆ slesBegin()

◆ slesEnd()

◆ slesUpperBound() [1/2]

◆ slesUpperBound() [2/2]

◆ txsBegin()

◆ txsEnd()

◆ txExists()

◆ txRead()

◆ digest()

◆ parentCloseTime()

◆ seq()

◆ balanceHook()

◆ ownerCountHook()

Member Data Documentation

◆ sp_

◆ base_

◆ cache_

◆ mutex_

◆ map_

◆ sles

◆ txs