catapult::cache::SubCacheView Class Reference

Sub cache view. More...

Inheritance diagram for catapult::cache::SubCacheView:

Public Member Functions
virtual	~SubCacheView ()=default
virtual const SubCacheViewIdentifier &	id () const =0
	Gets view identifier. More...
virtual const void *	get () const =0
	Returns a const pointer to the underlying view. More...
virtual void *	get ()=0
	Returns a pointer to the underlying view. More...
virtual bool	supportsMerkleRoot () const =0
	Returns true if cache supports merkle root. More...
virtual bool	tryGetMerkleRoot (Hash256 &merkleRoot) const =0
	Gets the cache merkle root (merkleRoot) if supported. More...
virtual bool	trySetMerkleRoot (const Hash256 &merkleRoot)=0
	Sets the cache merkle root (merkleRoot) if supported. More...
virtual void	updateMerkleRoot (Height height)=0
	Recalculates the merkle root given the specified chain height if supported. More...
virtual const void *	asReadOnly () const =0
	Returns a read-only view of this view. More...

Detailed Description

Sub cache view.

Constructor & Destructor Documentation

~SubCacheView()

virtual catapult::cache::SubCacheView::~SubCacheView ( )

virtualdefault

Member Function Documentation

asReadOnly()

virtual const void* catapult::cache::SubCacheView::asReadOnly ( ) const

pure virtual

Returns a read-only view of this view.

Implemented in catapult::cache::SubCachePluginAdapter< TCache, TStorageTraits >::SubCacheViewAdapter< TView >.

get() [1/2]

virtual const void* catapult::cache::SubCacheView::get ( ) const

pure virtual

Returns a const pointer to the underlying view.

Implemented in catapult::cache::SubCachePluginAdapter< TCache, TStorageTraits >::SubCacheViewAdapter< TView >.

get() [2/2]

virtual void* catapult::cache::SubCacheView::get ( )

pure virtual

Returns a pointer to the underlying view.

Implemented in catapult::cache::SubCachePluginAdapter< TCache, TStorageTraits >::SubCacheViewAdapter< TView >.

id()

virtual const SubCacheViewIdentifier& catapult::cache::SubCacheView::id ( ) const

pure virtual

Gets view identifier.

Implemented in catapult::cache::SubCachePluginAdapter< TCache, TStorageTraits >::SubCacheViewAdapter< TView >.

supportsMerkleRoot()

virtual bool catapult::cache::SubCacheView::supportsMerkleRoot ( ) const

pure virtual

Returns true if cache supports merkle root.

Implemented in catapult::cache::SubCachePluginAdapter< TCache, TStorageTraits >::SubCacheViewAdapter< TView >.

tryGetMerkleRoot()

virtual bool catapult::cache::SubCacheView::tryGetMerkleRoot ( Hash256 &  merkleRoot ) const

pure virtual

Gets the cache merkle root (merkleRoot) if supported.

Implemented in catapult::cache::SubCachePluginAdapter< TCache, TStorageTraits >::SubCacheViewAdapter< TView >.

trySetMerkleRoot()

virtual bool catapult::cache::SubCacheView::trySetMerkleRoot ( const Hash256 &  merkleRoot )

pure virtual

Sets the cache merkle root (merkleRoot) if supported.

Implemented in catapult::cache::SubCachePluginAdapter< TCache, TStorageTraits >::SubCacheViewAdapter< TView >.

updateMerkleRoot()

virtual void catapult::cache::SubCacheView::updateMerkleRoot ( Height  height )

pure virtual

Recalculates the merkle root given the specified chain height if supported.

Implemented in catapult::cache::SubCachePluginAdapter< TCache, TStorageTraits >::SubCacheViewAdapter< TView >.

---

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

• SubCachePlugin.h