Struct sc_network::NetworkService
source · pub struct NetworkService<B: BlockT + 'static, H: ExHashT> { /* private fields */ }
Expand description
Substrate network service. Handles network IO and manages connectivity.
Implementations§
source§impl<B: BlockT + 'static, H: ExHashT> NetworkService<B, H>
impl<B: BlockT + 'static, H: ExHashT> NetworkService<B, H>
sourcepub async fn network_state(&self) -> Result<NetworkState, ()>
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.
Trait Implementations§
source§impl<B: BlockT, H: ExHashT> JustificationSyncLink<B> for NetworkService<B, H>
impl<B: BlockT, H: ExHashT> JustificationSyncLink<B> for NetworkService<B, H>
source§fn request_justification(&self, hash: &B::Hash, number: NumberFor<B>)
fn request_justification(&self, hash: &B::Hash, number: NumberFor<B>)
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.
source§fn clear_justification_requests(&self)
fn clear_justification_requests(&self)
source§impl<B, H> NetworkBlock<<B as Block>::Hash, <<B as Block>::Header as Header>::Number> for NetworkService<B, H>where
B: BlockT + 'static,
H: ExHashT,
impl<B, H> NetworkBlock<<B as Block>::Hash, <<B as Block>::Header as Header>::Number> for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,
source§impl<B, H> NetworkDHTProvider for NetworkService<B, H>where
B: BlockT + 'static,
H: ExHashT,
impl<B, H> NetworkDHTProvider for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,
source§fn get_value(&self, key: &KademliaKey)
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.
source§fn put_value(&self, key: KademliaKey, value: Vec<u8>)
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.
source§impl<B, H> NetworkEventStream for NetworkService<B, H>where
B: BlockT + 'static,
H: ExHashT,
impl<B, H> NetworkEventStream for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,
source§impl<B, H> NetworkNotification for NetworkService<B, H>where
B: BlockT + 'static,
H: ExHashT,
impl<B, H> NetworkNotification for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,
source§fn write_notification(
&self,
target: PeerId,
protocol: ProtocolName,
message: Vec<u8>
)
fn write_notification( &self, target: PeerId, protocol: ProtocolName, message: Vec<u8> )
source§fn notification_sender(
&self,
target: PeerId,
protocol: ProtocolName
) -> Result<Box<dyn NotificationSenderT>, NotificationSenderError>
fn notification_sender( &self, target: PeerId, protocol: ProtocolName ) -> Result<Box<dyn NotificationSenderT>, NotificationSenderError>
NotificationSender
for a connected peer, if it exists. Read moresource§impl<B, H> NetworkPeers for NetworkService<B, H>where
B: BlockT + 'static,
H: ExHashT,
impl<B, H> NetworkPeers for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,
source§fn add_known_address(&self, peer_id: PeerId, addr: Multiaddr)
fn add_known_address(&self, peer_id: PeerId, addr: Multiaddr)
source§fn report_peer(&self, who: PeerId, cost_benefit: ReputationChange)
fn report_peer(&self, who: PeerId, cost_benefit: ReputationChange)
source§fn disconnect_peer(&self, who: PeerId, protocol: ProtocolName)
fn disconnect_peer(&self, who: PeerId, protocol: ProtocolName)
source§fn accept_unreserved_peers(&self)
fn accept_unreserved_peers(&self)
source§fn deny_unreserved_peers(&self)
fn deny_unreserved_peers(&self)
source§fn add_reserved_peer(&self, peer: MultiaddrWithPeerId) -> Result<(), String>
fn add_reserved_peer(&self, peer: MultiaddrWithPeerId) -> Result<(), String>
source§fn remove_reserved_peer(&self, peer_id: PeerId)
fn remove_reserved_peer(&self, peer_id: PeerId)
PeerId
from the list of reserved peers.source§fn set_reserved_peers(
&self,
protocol: ProtocolName,
peers: HashSet<Multiaddr>
) -> Result<(), String>
fn set_reserved_peers( &self, protocol: ProtocolName, peers: HashSet<Multiaddr> ) -> Result<(), String>
source§fn add_peers_to_reserved_set(
&self,
protocol: ProtocolName,
peers: HashSet<Multiaddr>
) -> Result<(), String>
fn add_peers_to_reserved_set( &self, protocol: ProtocolName, peers: HashSet<Multiaddr> ) -> Result<(), String>
source§fn remove_peers_from_reserved_set(
&self,
protocol: ProtocolName,
peers: Vec<PeerId>
)
fn remove_peers_from_reserved_set( &self, protocol: ProtocolName, peers: Vec<PeerId> )
source§fn add_to_peers_set(
&self,
protocol: ProtocolName,
peers: HashSet<Multiaddr>
) -> Result<(), String>
fn add_to_peers_set( &self, protocol: ProtocolName, peers: HashSet<Multiaddr> ) -> Result<(), String>
source§fn remove_from_peers_set(&self, protocol: ProtocolName, peers: Vec<PeerId>)
fn remove_from_peers_set(&self, protocol: ProtocolName, peers: Vec<PeerId>)
source§fn sync_num_connected(&self) -> usize
fn sync_num_connected(&self) -> usize
source§impl<B, H> NetworkRequest for NetworkService<B, H>where
B: BlockT + 'static,
H: ExHashT,
impl<B, H> NetworkRequest for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,
source§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,
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,
source§fn start_request(
&self,
target: PeerId,
protocol: ProtocolName,
request: Vec<u8>,
tx: Sender<Result<Vec<u8>, RequestFailure>>,
connect: IfDisconnected
)
fn start_request( &self, target: PeerId, protocol: ProtocolName, request: Vec<u8>, tx: Sender<Result<Vec<u8>, RequestFailure>>, connect: IfDisconnected )
request
which starts a request whose response is delivered on a provided
channel. Read moresource§impl<B, H> NetworkSigner for NetworkService<B, H>where
B: Block,
H: ExHashT,
impl<B, H> NetworkSigner for NetworkService<B, H>where B: Block, H: ExHashT,
source§fn sign_with_local_identity(
&self,
msg: impl AsRef<[u8]>
) -> Result<Signature, SigningError>
fn sign_with_local_identity( &self, msg: impl AsRef<[u8]> ) -> Result<Signature, SigningError>
KeyPair
that defines the local PeerId
.source§impl<B, H> NetworkStateInfo for NetworkService<B, H>where
B: Block,
H: ExHashT,
impl<B, H> NetworkStateInfo for NetworkService<B, H>where B: Block, H: ExHashT,
source§fn external_addresses(&self) -> Vec<Multiaddr>
fn external_addresses(&self) -> Vec<Multiaddr>
Returns the local external addresses.
source§fn local_peer_id(&self) -> PeerId
fn local_peer_id(&self) -> PeerId
Returns the local Peer ID.
source§impl<B, H> NetworkStatusProvider<B> for NetworkService<B, H>where
B: BlockT + 'static,
H: ExHashT,
impl<B, H> NetworkStatusProvider<B> for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,
source§impl<B, H> NetworkSyncForkRequest<<B as Block>::Hash, <<B as Block>::Header as Header>::Number> for NetworkService<B, H>where
B: BlockT + 'static,
H: ExHashT,
impl<B, H> NetworkSyncForkRequest<<B as Block>::Hash, <<B as Block>::Header as Header>::Number> for NetworkService<B, H>where B: BlockT + 'static, H: ExHashT,
source§fn set_sync_fork_request(
&self,
peers: Vec<PeerId>,
hash: B::Hash,
number: NumberFor<B>
)
fn set_sync_fork_request( &self, peers: Vec<PeerId>, hash: B::Hash, number: NumberFor<B> )
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.
source§impl<B: BlockT + 'static, H: ExHashT> SyncOracle for NetworkService<B, H>
impl<B: BlockT + 'static, H: ExHashT> SyncOracle for NetworkService<B, H>
source§fn is_major_syncing(&self) -> bool
fn is_major_syncing(&self) -> bool
source§fn is_offline(&self) -> bool
fn is_offline(&self) -> bool
Auto Trait Implementations§
impl<B, H> !RefUnwindSafe for NetworkService<B, H>
impl<B, H> Send for NetworkService<B, H>
impl<B, H> Sync for NetworkService<B, H>
impl<B, H> Unpin for NetworkService<B, H>where H: Unpin,
impl<B, H> !UnwindSafe for NetworkService<B, H>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
source§fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T, Outer> IsWrappedBy<Outer> for Twhere
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,
impl<T, Outer> IsWrappedBy<Outer> for Twhere Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_mut()
into the pipe
function.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
source§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere Self: UniqueSaturatedFrom<T>,
source§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere Self: UniqueSaturatedInto<T>,
T
. Read moresource§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere T: UncheckedFrom<S>,
source§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from
.source§impl<T, S> UniqueSaturatedInto<T> for Swhere
T: Bounded,
S: TryInto<T>,
impl<T, S> UniqueSaturatedInto<T> for Swhere T: Bounded, S: TryInto<T>,
source§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
T
.