Struct sc_network::NetworkService

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

Substrate network service. Handles network IO and manages connectivity.

Implementations

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

pub async fn network_state(&self) -> Result<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.

Returns an error if the NetworkWorker is no longer running.

pub async fn reserved_peers(&self) -> Result<Vec<PeerId>, ()>

Get the list of reserved peers.

Returns an error if the NetworkWorker is no longer running.

Trait Implementations

impl<B, H> NetworkDHTProvider for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,

fn get_value(&self, key: &KademliaKey)

Start getting a value from the DHT.

This will generate either a ValueFound or a ValueNotFound event and pass it as an item on the NetworkWorker stream.

fn put_value(&self, key: KademliaKey, value: Vec<u8>)

Start putting a value in the DHT.

This will generate either a ValuePut or a ValuePutFailed event and pass it as an item on the NetworkWorker stream.

impl<B, H> NetworkEventStream for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,

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

Returns a stream containing the events that happen on the network.

impl<B, H> NetworkNotification for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,

fn write_notification( &self, target: PeerId, protocol: ProtocolName, message: Vec<u8> )

Appends a notification to the buffer of pending outgoing notifications with the given peer. Has no effect if the notifications channel with this protocol name is not open.

fn notification_sender( &self, target: PeerId, protocol: ProtocolName ) -> Result<Box<dyn NotificationSenderT>, NotificationSenderError>

Obtains a NotificationSender for a connected peer, if it exists.

fn set_notification_handshake(&self, protocol: ProtocolName, handshake: Vec<u8>)

Set handshake for the notification protocol.

impl<B, H> NetworkPeers for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,

fn set_authorized_peers(&self, peers: HashSet<PeerId>)

Set authorized peers.

fn set_authorized_only(&self, reserved_only: bool)

Set authorized_only flag.

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

Adds an address known to a node.

fn report_peer(&self, who: PeerId, cost_benefit: ReputationChange)

Report a given peer as either beneficial (+) or costly (-) according to the given scalar.

fn disconnect_peer(&self, who: PeerId, protocol: ProtocolName)

Disconnect from a node as soon as possible.

fn accept_unreserved_peers(&self)

Connect to unreserved peers and allow unreserved peers to connect for syncing purposes.

fn deny_unreserved_peers(&self)

Disconnect from unreserved peers and deny new unreserved peers to connect for syncing purposes.

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

Adds a PeerId and its Multiaddr as reserved for a sync protocol (default peer set).

fn remove_reserved_peer(&self, peer_id: PeerId)

Removes a PeerId from the list of reserved peers for a sync protocol (default peer set).

fn set_reserved_peers( &self, protocol: ProtocolName, peers: HashSet<Multiaddr> ) -> Result<(), String>

Sets the reserved set of a protocol to the given set of peers.

fn add_peers_to_reserved_set( &self, protocol: ProtocolName, peers: HashSet<Multiaddr> ) -> Result<(), String>

Add peers to a peer set.

fn remove_peers_from_reserved_set( &self, protocol: ProtocolName, peers: Vec<PeerId> ) -> Result<(), String>

Remove peers from a peer set.

fn sync_num_connected(&self) -> usize

Returns the number of peers in the sync peer set we’re connected to.

impl<B, H> NetworkRequest for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,

fn request<'life0, 'async_trait>( &'life0 self, target: PeerId, protocol: ProtocolName, request: Vec<u8>, connect: IfDisconnected ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, RequestFailure>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Sends a single targeted request to a specific peer. On success, returns the response of the peer.

fn start_request( &self, target: PeerId, protocol: ProtocolName, request: Vec<u8>, tx: Sender<Result<Vec<u8>, RequestFailure>>, connect: IfDisconnected )

Variation of request which starts a request whose response is delivered on a provided channel.

impl<B, H> NetworkSigner for NetworkService<B, H>where B: Block, H: ExHashT,

fn sign_with_local_identity( &self, msg: impl AsRef<[u8]> ) -> Result<Signature, SigningError>

Signs the message with the KeyPair that defines the local PeerId.

impl<B, H> NetworkStateInfo for NetworkService<B, H>where B: Block, H: ExHashT,

fn external_addresses(&self) -> Vec<Multiaddr>

Returns the local external addresses.

fn listen_addresses(&self) -> Vec<Multiaddr>

Returns the listener addresses (without trailing /p2p/ with our PeerId).

fn local_peer_id(&self) -> PeerId

Returns the local Peer ID.

impl<B, H> NetworkStatusProvider for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,

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

High-level network status information.