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

Inheritance diagram for catapult::api::RemoteChainApi:

[legend]

Collaboration diagram for catapult::api::RemoteChainApi:

[legend]

Public Member Functions
virtual thread::future< std::shared_ptr< const model::Block > >	blockLast () const =0
	Gets the last block. More...

virtual thread::future< std::shared_ptr< const model::Block > >	blockAt (Height height) const =0
	Gets the block at height. More...

virtual thread::future< model::BlockRange >	blocksFrom (Height height, const BlocksFromOptions &options) const =0

Public Member Functions inherited from catapult::api::RemoteApi
virtual	~RemoteApi ()=default

const Key &	remotePublicKey () const
	Gets the remote node public key. More...

Public Member Functions inherited from catapult::api::ChainApi
virtual	~ChainApi ()=default

virtual thread::future< ChainInfo >	chainInfo () const =0
	Gets information about the chain. More...

virtual thread::future< model::HashRange >	hashesFrom (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...

NonCopyable &	operator= (const NonCopyable &)=delete
	Disabled assignment operator. More...

Protected Member Functions
	RemoteChainApi (const Key &remotePublicKey)
	Creates a remote api for the node with specified public key (remotePublicKey). More...

Protected Member Functions inherited from catapult::api::RemoteApi
	RemoteApi (const Key &remotePublicKey)
	Creates a remote api for the node with specified public key (remotePublicKey). More...

Detailed Description

An api for retrieving chain information from a remote node.

Constructor & Destructor Documentation

catapult::api::RemoteChainApi::RemoteChainApi ( const Key & remotePublicKey )

inlineexplicitprotected

Creates a remote api for the node with specified public key (remotePublicKey).

virtual thread::future<std::shared_ptr<const model::Block> > catapult::api::RemoteChainApi::blockAt ( Height height ) const

pure virtual

Gets the block at height.

virtual thread::future<std::shared_ptr<const model::Block> > catapult::api::RemoteChainApi::blockLast ( ) const

pure virtual

Gets the last block.

virtual thread::future<model::BlockRange> catapult::api::RemoteChainApi::blocksFrom	(	Height	height,
		const BlocksFromOptions &	options
	)		const

pure virtual

Gets the blocks starting at height with the specified options.

Note: An empty range will be returned if remote chain height is less than height.

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