CatapultServer  v0.5.0.1 (Elephant)
catapult::api::ChainApi Class Referenceabstract

An api for retrieving chain information from a node. More...

Inheritance diagram for catapult::api::ChainApi:
Collaboration diagram for catapult::api::ChainApi:

Public Member Functions

virtual ~ChainApi ()=default
 
virtual thread::future< ChainInfochainInfo () const =0
 Gets information about the chain. More...
 
virtual thread::future< model::HashRangehashesFrom (Height height, uint32_t maxHashes) const =0
 Gets at most maxHashes hashes starting at height. More...
 
- Public Member Functions inherited from catapult::utils::NonCopyable
constexpr NonCopyable ()=default
 Default constructor. More...
 
 ~NonCopyable ()=default
 Default destructor. More...
 
 NonCopyable (const NonCopyable &)=delete
 Disabled copy constructor. More...
 
NonCopyableoperator= (const NonCopyable &)=delete
 Disabled assignment operator. More...
 

Detailed Description

An api for retrieving chain information from a node.

Constructor & Destructor Documentation

◆ ~ChainApi()

virtual catapult::api::ChainApi::~ChainApi ( )
virtualdefault

Member Function Documentation

◆ chainInfo()

virtual thread::future<ChainInfo> catapult::api::ChainApi::chainInfo ( ) const
pure virtual

Gets information about the chain.

◆ hashesFrom()

virtual thread::future<model::HashRange> catapult::api::ChainApi::hashesFrom ( Height  height,
uint32_t  maxHashes 
) const
pure virtual

Gets at most maxHashes hashes starting at height.


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