Struct sc_network_sync::service::chain_sync::SyncingService

impl<B: BlockT> SyncingService

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

Create new handle

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

Get the number of active peers.

pub async fn best_seen_block(&self) -> Result<Option<NumberFor>, Canceled>

Get best seen block.

pub async fn num_sync_peers(&self) -> Result<u32, Canceled>

Get the number of sync peers.

pub async fn num_queued_blocks(&self) -> Result<u32, Canceled>

Get the number of queued blocks.

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)>, 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, ()>

Get sync status

Returns an error if ChainSync has terminated.

Trait Implementations§

impl<B: Clone + BlockT> Clone for SyncingService

fn clone(&self) -> SyncingService

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<B: BlockT> JustificationSyncLink for SyncingService

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

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 for SyncingService

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

Batch of blocks imported, with or without error.

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

Justification import result.

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

Request a justification for the given block.

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

Make sure an important block is propagated to peers. Read more

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

Inform the network service about new best imported block.

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

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

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

Get syncing event stream.

impl<B: BlockT> SyncOracle for SyncingService

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 for SyncingService

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

Get high-level view of the syncing status.

Auto Trait Implementations§

impl !UnwindSafe for SyncingService

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Any for Twhere T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn type_name(&self) -> &'static str

impl<T> AnySync for Twhere T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self>where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

fn checked_into<T>(self) -> Option<T>where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> DynClone for Twhere T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, Outer> IsWrappedBy<Outer> for Twhere Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> SaturatedConversion for T

fn saturated_from<T>(t: T) -> Selfwhere Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more

fn saturated_into<T>(self) -> Twhere Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for Twhere U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source§

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<S, T> UncheckedInto<T> for Swhere T: UncheckedFrom<S>,

fn unchecked_into(self) -> T

The counterpart to unchecked_from.

impl<T, S> UniqueSaturatedInto<T> for Swhere T: Bounded, S: TryInto<T>,

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more