Kagome
Polkadot Runtime Engine in C++17
Public Member Functions | List of all members
kagome::telemetry::TelemetryService Class Referenceabstract

#include <service.hpp>

Inheritance diagram for kagome::telemetry::TelemetryService:
Collaboration diagram for kagome::telemetry::TelemetryService:

Public Member Functions

virtual ~TelemetryService ()=default
 
virtual void setGenesisBlockHash (const primitives::BlockHash &hash)=0
 
virtual void notifyWasSynchronized ()=0
 
virtual void notifyBlockImported (const primitives::BlockInfo &info, BlockOrigin origin)=0
 
virtual void notifyBlockFinalized (const primitives::BlockInfo &info)=0
 
virtual bool isEnabled () const =0
 

Detailed Description

Telemetry service interface

Definition at line 44 of file service.hpp.

Constructor & Destructor Documentation

virtual kagome::telemetry::TelemetryService::~TelemetryService ( )
virtualdefault

Member Function Documentation

virtual bool kagome::telemetry::TelemetryService::isEnabled ( ) const
pure virtual

Telemetry service status

Returns
true - when application configured to broadcast telemetry

Implemented in kagome::telemetry::TelemetryServiceImpl.

virtual void kagome::telemetry::TelemetryService::notifyBlockFinalized ( const primitives::BlockInfo &  info)
pure virtual

Inform about the last finalized block

Parameters
info- block info

Implemented in kagome::telemetry::TelemetryServiceImpl.

virtual void kagome::telemetry::TelemetryService::notifyBlockImported ( const primitives::BlockInfo &  info,
BlockOrigin  origin 
)
pure virtual

Inform about last known block

Parameters
info- block info
origin- source of the block

Implemented in kagome::telemetry::TelemetryServiceImpl.

virtual void kagome::telemetry::TelemetryService::notifyWasSynchronized ( )
pure virtual

Let the telemetry service know that the node has been in a synchronized state at least once.

After this call all kNetworkInitialSync events will be treated as kNetworkBroadcast

Implemented in kagome::telemetry::TelemetryServiceImpl.

virtual void kagome::telemetry::TelemetryService::setGenesisBlockHash ( const primitives::BlockHash &  hash)
pure virtual

Used to initially inform the service about the genesis hash.

Parameters
hashgenesis hash for the network

Allows to avoid circular references in classes dependency tree

Implemented in kagome::telemetry::TelemetryServiceImpl.

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