Struct Syncing Service &nbsp; Copy item path

impl<B: BlockT> SyncingService

pub fn new( tx: TracingUnboundedSender<ToServiceCommand>, 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)>, 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 fn set_no_slot_peers(&self, peers: HashSet<PeerId>)

Replace the dynamic set of no-slot peer set.

The engine maintains a per-role inbound-peer counter on top of the underlying network’s reserved-peer handling (since https://github.com/paritytech/substrate/pull/14603) to ensure the --in-peers budget is enforced specifically for full peers in default notification set. A peer in either the static (config-time) or dynamic (this) no-slot set bypasses that counter, exactly mirroring what reserved-peer handling does at the network layer.

Each call replaces the dynamic set. The engine reconciles against its previous dynamic set. Peers added are promoted (taken off the inbound budget). Peers removed are demoted (counted again, or disconnected if doing so would now exceed --in-peers).

Callers that maintain a dynamic reserved-peer relationship (e.g. parachain collator-discovery) must call this in lockstep with set_reserved_peers using the same peer set, so the two layers stay in sync.

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

Get sync status

Returns an error if SyncingEngine has terminated.

Trait Implementations§

impl<B: Clone + BlockT> Clone for SyncingService

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · 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( &self, imported: usize, count: usize, results: Vec<(Result<BlockImportStatus<NumberFor>, BlockImportError>, B::Hash)>, )

Batch of blocks imported, with or without error.

fn justification_imported( &self, who: PeerId, hash: &B::Hash, number: NumberFor, import_result: JustificationImportResult, )

Justification import result.

fn request_justification(&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 Freeze for SyncingService
where TracingUnboundedSender<ToServiceCommand>: Freeze,

impl RefUnwindSafe for SyncingService
where TracingUnboundedSender<ToServiceCommand>: RefUnwindSafe,

impl Send for SyncingService
where TracingUnboundedSender<ToServiceCommand>: Send,

impl Sync for SyncingService
where TracingUnboundedSender<ToServiceCommand>: Sync,

impl Unpin for SyncingService
where TracingUnboundedSender<ToServiceCommand>: Unpin,

impl UnsafeUnpin for SyncingService
where TracingUnboundedSender<ToServiceCommand>: UnsafeUnpin,

impl UnwindSafe for SyncingService
where TracingUnboundedSender<ToServiceCommand>: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DynClone for T
where T: Clone,

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

impl<T> From<T> for T

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 T
where U: From<T>,

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> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<Src, Dest> IntoTuple<Dest> for Src
where Dest: FromTuple<Src>,

fn into_tuple(self) -> Dest

impl<T> JsonSchemaMaybe for T

impl<T> MaybeRefUnwindSafe for T
where T: RefUnwindSafe,

impl<T> Pointable for T

const ALIGN: usize

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SaturatedConversion for T

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

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

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

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

impl<T> ToOwned for T
where 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 T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn unchecked_into(self) -> T

The counterpart to unchecked_from.

impl<T, S> UniqueSaturatedInto<T> for S
where 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 T
where 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