Struct sc_network::NetworkWorker[−][src]

pub struct NetworkWorker<B: BlockT + 'static, H: ExHashT> { /* fields omitted */ }

Expand description

Main network worker. Must be polled in order for the network to advance.

You are encouraged to poll this in a separate background thread or task.

Implementations

[src]

impl<B: BlockT + 'static, H: ExHashT> NetworkWorker<B, H>

[src]

pub fn new(params: Params<B, H>) -> Result<NetworkWorker<B, H>, Error>

Creates the network service.

Returns a NetworkWorker that implements Future and must be regularly polled in order for the network processing to advance. From it, you can extract a NetworkService using worker.service(). The NetworkService can be shared through the codebase.

[src]

pub fn status(&self) -> NetworkStatus

High-level network status information.

[src]

pub fn total_bytes_inbound(&self) -> u64

Returns the total number of bytes received so far.

[src]

pub fn total_bytes_outbound(&self) -> u64

Returns the total number of bytes sent so far.

[src]

pub fn num_connected_peers(&self) -> usize

Returns the number of peers we’re connected to.

[src]

pub fn num_active_peers(&self) -> usize

Returns the number of peers we’re connected to and that are being queried.

[src]

pub fn sync_state(&self) -> SyncStatus

Current global sync state.

[src]

pub fn best_seen_block(&self) -> Option<NumberFor>

Target sync block number.

[src]

pub fn num_sync_peers(&self) -> u32

Number of peers participating in syncing.

[src]

pub fn num_queued_blocks(&self) -> u32

Number of blocks in the import queue.

[src]

pub fn num_downloaded_blocks(&self) -> usize

Returns the number of downloaded blocks.

[src]

pub fn num_sync_requests(&self) -> usize

Number of active sync requests.

[src]

pub fn add_known_address(&mut self, peer_id: PeerId, addr: Multiaddr)

Adds an address for a node.

[src]

pub fn service(&self) -> &Arc<NetworkService<B, H>>

Return a NetworkService that can be shared through the code base and can be used to manipulate the worker.

[src]

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

You must call this when a new block is finalized by the client.

[src]

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

Inform the network service about new best imported block.

[src]

pub fn local_peer_id(&self) -> &PeerId

Returns the local PeerId.

[src]

pub fn listen_addresses(&self) -> impl Iterator<Item = &Multiaddr>

Returns the list of addresses we are listening on.

Does NOT include a trailing /p2p/ with our PeerId.

[src]

pub fn network_state(&mut self) -> NetworkState

Get network state.

Note: Use this only for debugging. This API is unstable. There are warnings literally everywhere about this. Please don’t use this function to retrieve actual information.

[src]

pub fn peers_debug_info(&mut self) -> Vec<(PeerId, PeerInfo)>

Get currently connected peers.

[src]

pub fn remove_reserved_peer(&self, peer: PeerId)

Removes a PeerId from the list of reserved peers.

[src]

pub fn add_reserved_peer(&self, peer: String) -> Result<(), String>

Adds a PeerId and its address as reserved. The string should encode the address and peer ID of the remote node.

[src]

pub fn reserved_peers(&self) -> impl Iterator<Item = &PeerId>

Returns the list of reserved peers.

Trait Implementations

[src]

impl<B: BlockT + 'static, H: ExHashT> Future for NetworkWorker<B, H>

type Output = ()

The type of value produced on completion.

[src]

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

[src]

impl<B: BlockT + 'static, H: ExHashT> Unpin for NetworkWorker<B, H>

Auto Trait Implementations

impl<B, H> !RefUnwindSafe for NetworkWorker<B, H>

impl<B, H> Send for NetworkWorker<B, H>

impl<B, H> !Sync for NetworkWorker<B, H>

impl<B, H> !UnwindSafe for NetworkWorker<B, H>

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> CheckedConversion for T

[src]

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

[src]

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> Downcast for T where
    T: Any,

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

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

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

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
    T: Any + Send + Sync,

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

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

impl<T> FutureExt for T where
    T: Future + ?Sized,

fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Output) -> U,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

fn map_into<U>(self) -> MapInto<Self, U> where
    Self::Output: Into<U>,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnOnce(Self::Output) -> Fut,
    Fut: Future,

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

fn left_future<B>(self) -> Either<Self, B> where
    B: Future<Output = Self::Output>,

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

fn right_future<A>(self) -> Either<A, Self> where
    A: Future<Output = Self::Output>,

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Output: Future,

Flatten the execution of this future when the output of this future is itself another future. Read more

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Output: Stream,

Flatten the execution of this future when the successful result of this future is a stream. Read more

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Output),

Do something with the output of a future before passing it on. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe,

Catches unwinding panics while polling the future. Read more

fn shared(self) -> Shared<Self> where
    Self::Output: Clone,

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)

Turn this future into a future that yields () on completion and sends its output to another future on a separate task. Read more

fn boxed<'a>(
    self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
    Self: Send + 'a,

Wrap the future in a Box, pinning it. Read more

fn boxed_local<'a>(
    self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
    Self: 'a,

Wrap the future in a Box, pinning it. Read more

fn unit_error(self) -> UnitError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = ()>. Read more

fn never_error(self) -> NeverError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = Never>. Read more

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
    Self: Unpin,

A convenience for calling Future::poll on Unpin future types.

fn now_or_never(self) -> Option<Self::Output>

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more

impl<T> FutureExt for T where
    T: Future + ?Sized,

fn delay(self, dur: Duration) -> DelayFuture<Self>

Returns a Future that delays execution for a specified time. Read more

fn flatten(self) -> FlattenFuture<Self, <Self::Output as IntoFuture>::Future> where
    Self::Output: IntoFuture,

Flatten out the execution of this future when the result itself can be converted into another future. Read more

fn race<F>(self, other: F) -> Race<Self, F> where
    Self: Future,
    F: Future<Output = Self::Output>,

Waits for one of two similarly-typed futures to complete. Read more

fn try_race<F, T, E>(self, other: F) -> TryRace<Self, F> where
    Self: Future<Output = Result<T, E>>,
    F: Future<Output = Self::Output>,

Waits for one of two similarly-typed fallible futures to complete. Read more

fn join<F>(self, other: F) -> Join<Self, F> where
    Self: Future,
    F: Future,

Waits for two similarly-typed futures to complete. Read more

fn try_join<F, A, B, E>(self, other: F) -> TryJoin<Self, F> where
    Self: Future<Output = Result<A, E>>,
    F: Future<Output = Result<B, E>>,

Waits for two similarly-typed fallible futures to complete. Read more

fn timeout(self, dur: Duration) -> TimeoutFuture<Self>

Waits for both the future and a timeout, if the timeout completes before the future, it returns an TimeoutError. Read more

impl<F> FutureExt for F where
    F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
    Self: Unpin,

A convenience for calling Future::poll() on !Unpin types.

fn or<F>(self, other: F) -> Or<Self, F> where
    F: Future<Output = Self::Output>,

Returns the result of self or other future, preferring self if both are ready. Read more

fn race<F>(self, other: F) -> Race<Self, F> where
    F: Future<Output = Self::Output>,

Returns the result of self or other future, with no preference if both are ready. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe,

Catches panics while polling the future. Read more

fn boxed<'a>(
    self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
    Self: Send + 'a,

Boxes the future and changes its type to dyn Future + Send + 'a. Read more

fn boxed_local<'a>(
    self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
    Self: 'a,

Boxes the future and changes its type to dyn Future + 'a. Read more

[src]

impl<T> Instrument for T

[src]

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

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

[src]

fn in_current_span(self) -> Instrumented<Self>

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

[src]

impl<T> Instrument for T

[src]

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

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

[src]

fn in_current_span(self) -> Instrumented<Self>

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

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<F> IntoFuture for F where
    F: Future,

type Output = <F as Future>::Output

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

The output that the future will produce on completion.

type Future = F

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

Which kind of future are we turning this into?

[src]

pub fn into_future(self) -> <F as IntoFuture>::Future

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

Creates a future from a value.

impl<T> IntoFuture for T where
    T: Future,

type Output = <T as Future>::Output

The type of value produced on completion.

type Future = T

Which kind of future are we turning this into?

pub fn into_future(self) -> <T as IntoFuture>::Future

Create a future from a value

[src]

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

[src]

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

Get a reference to the inner from the outer.

[src]

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

Get a mutable reference to the inner from the outer.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub 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

[src]

impl<T> SaturatedConversion for T

[src]

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

[src]

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

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

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

[src]

pub fn unchecked_into(self) -> T

The counterpart to unchecked_from.

[src]

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

[src]

pub 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>,

pub fn vzip(self) -> V

[src]

impl<T> WithSubscriber for T

[src]

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

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>

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