Struct SyncingService

pub struct SyncingService<B: BlockT> { /* private fields */ }

Handle for communicating with SyncingEngine asynchronously

Implementations

impl<B: BlockT> SyncingService<B>

pub fn new( tx: TracingUnboundedSender<ToServiceCommand<B>>, num_connected: Arc<AtomicUsize>, is_major_syncing: Arc<AtomicBool>, ) -> Self

Create new handle

pub fn num_connected_peers(&self) -> usize

Get the number of peers known to SyncingEngine (both full and light).

pub async fn num_active_peers(&self) -> Result<usize, Canceled>

Get the number of active peers.

pub async fn num_downloaded_blocks(&self) -> Result<usize, Canceled>

Get the number of downloaded blocks.

pub async fn num_sync_requests(&self) -> Result<usize, Canceled>

Get the number of sync requests.

pub async fn peers_info( &self, ) -> Result<Vec<(PeerId, ExtendedPeerInfo<B>)>, Canceled>

Get peer information.

pub fn on_block_finalized(&self, hash: B::Hash, header: B::Header)

Notify the SyncingEngine that a block has been finalized.

pub async fn status(&self) -> Result<SyncStatus<B>, Canceled>

Get sync status

Returns an error if SyncingEngine has terminated.

Trait Implementations

impl<B: Clone + BlockT> Clone for SyncingService<B>

fn clone(&self) -> SyncingService<B>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B: BlockT> JustificationSyncLink<B> for SyncingService<B>

fn request_justification(&self, hash: &B::Hash, number: NumberFor<B>)

Request a justification for the given block from the network.

On success, the justification will be passed to the import queue that was part at initialization as part of the configuration.

fn clear_justification_requests(&self)

Clear all pending justification requests.

impl<B: BlockT> Link<B> for SyncingService<B>

fn blocks_processed( &mut self, imported: usize, count: usize, results: Vec<(Result<BlockImportStatus<NumberFor<B>>, BlockImportError>, B::Hash)>, )

Batch of blocks imported, with or without error.

fn justification_imported( &mut self, who: PeerId, hash: &B::Hash, number: NumberFor<B>, success: bool, )

Justification import result.

fn request_justification(&mut self, hash: &B::Hash, number: NumberFor<B>)

Request a justification for the given block.

impl<B: BlockT> NetworkBlock<<B as Block>::Hash, <<B as Block>::Header as Header>::Number> for SyncingService<B>

fn announce_block(&self, hash: B::Hash, data: Option<Vec<u8>>)

Make sure an important block is propagated to peers.

fn new_best_block_imported(&self, hash: B::Hash, number: NumberFor<B>)

Inform the network service about new best imported block.

impl<B: BlockT + 'static> NetworkSyncForkRequest<<B as Block>::Hash, <<B as Block>::Header as Header>::Number> for SyncingService<B>

fn set_sync_fork_request( &self, peers: Vec<PeerId>, hash: B::Hash, number: NumberFor<B>, )

Configure an explicit fork sync request.

Note that this function should not be used for recent blocks. Sync should be able to download all the recent forks normally. set_sync_fork_request should only be used if external code detects that there’s a stale fork missing.

Passing empty peers set effectively removes the sync request.

impl<B: BlockT> SyncEventStream for SyncingService<B>

fn event_stream( &self, name: &'static str, ) -> Pin<Box<dyn Stream<Item = SyncEvent> + Send>>

Get syncing event stream.

impl<B: BlockT> SyncOracle for SyncingService<B>

fn is_major_syncing(&self) -> bool

Whether the synchronization service is undergoing major sync. Returns true if so.

fn is_offline(&self) -> bool

Whether the synchronization service is offline. Returns true if so.

impl<B: BlockT> SyncStatusProvider<B> for SyncingService<B>

fn status<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<SyncStatus<B>, ()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get high-level view of the syncing status.