Struct sc_network::NetworkWorker

pub struct NetworkWorker<B, H, Client>where
    B: BlockT + 'static,
    H: ExHashT,
    Client: HeaderBackend<B> + 'static,{ /* private fields */ }

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

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

pub fn new(params: Params<B, Client>) -> Result<Self, 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.

pub fn status(&self) -> NetworkStatus<B>

High-level network status information.

pub fn total_bytes_inbound(&self) -> u64

Returns the total number of bytes received so far.

pub fn total_bytes_outbound(&self) -> u64

Returns the total number of bytes sent so far.

pub fn num_connected_peers(&self) -> usize

Returns the number of peers we’re connected to.

pub fn num_active_peers(&self) -> usize

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

pub fn sync_state(&self) -> SyncStatus<B>

Current global sync state.

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

Target sync block number.

pub fn num_sync_peers(&self) -> u32

Number of peers participating in syncing.

pub fn num_queued_blocks(&self) -> u32

Number of blocks in the import queue.

pub fn num_downloaded_blocks(&self) -> usize

Returns the number of downloaded blocks.

pub fn num_sync_requests(&self) -> usize

Number of active sync requests.

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

Adds an address known to a node.

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.

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.

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

Inform the network service about new best imported block.

pub fn local_peer_id(&self) -> &PeerId

Returns the local PeerId.

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.

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.

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

Get currently connected peers.

pub fn remove_reserved_peer(&self, peer: PeerId)

Removes a PeerId from the list of reserved peers.

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

Adds a PeerId and its Multiaddr as reserved.

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

Returns the list of reserved peers.

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

pub async fn run(self)

Run the network.

pub async fn next_action(&mut self) -> bool

Perform one action on the network.

Returns false when the worker should be shutdown. Use in tests only.

Trait Implementations

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