pub struct Behaviour<P>where
P: Provider,{ /* private fields */ }
Expand description
A NetworkBehaviour
for mDNS. Automatically discovers peers on the local network and adds
them to the topology.
Implementations§
source§impl<P> Behaviour<P>where
P: Provider,
impl<P> Behaviour<P>where P: Provider,
sourcepub fn new(config: Config, local_peer_id: PeerId) -> Result<Behaviour<P>, Error>
pub fn new(config: Config, local_peer_id: PeerId) -> Result<Behaviour<P>, Error>
Builds a new Mdns
behaviour.
sourcepub fn has_node(&self, peer_id: &PeerId) -> bool
pub fn has_node(&self, peer_id: &PeerId) -> bool
Returns true if the given PeerId
is in the list of nodes discovered through mDNS.
sourcepub fn discovered_nodes(&self) -> impl ExactSizeIterator
pub fn discovered_nodes(&self) -> impl ExactSizeIterator
Returns the list of nodes that we have discovered through mDNS and that are not expired.
sourcepub fn expire_node(&mut self, peer_id: &PeerId)
pub fn expire_node(&mut self, peer_id: &PeerId)
Expires a node before the ttl.
Trait Implementations§
source§impl<P> Debug for Behaviour<P>where
P: Debug + Provider,
<P as Provider>::Watcher: Debug,
<P as Provider>::Socket: Debug,
<P as Provider>::Timer: Debug,
impl<P> Debug for Behaviour<P>where P: Debug + Provider, <P as Provider>::Watcher: Debug, <P as Provider>::Socket: Debug, <P as Provider>::Timer: Debug,
source§impl<P> NetworkBehaviour for Behaviour<P>where
P: Provider,
impl<P> NetworkBehaviour for Behaviour<P>where P: Provider,
§type ConnectionHandler = ConnectionHandler
type ConnectionHandler = ConnectionHandler
Handler for all the protocols the network behaviour supports.
source§fn handle_established_inbound_connection(
&mut self,
_: ConnectionId,
_: PeerId,
_: &Multiaddr,
_: &Multiaddr
) -> Result<<<Behaviour<P> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler, ConnectionDenied>
fn handle_established_inbound_connection( &mut self, _: ConnectionId, _: PeerId, _: &Multiaddr, _: &Multiaddr ) -> Result<<<Behaviour<P> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler, ConnectionDenied>
Callback that is invoked for every established inbound connection. Read more
source§fn handle_pending_outbound_connection(
&mut self,
_connection_id: ConnectionId,
maybe_peer: Option<PeerId>,
_addresses: &[Multiaddr],
_effective_role: Endpoint
) -> Result<Vec<Multiaddr, Global>, ConnectionDenied>
fn handle_pending_outbound_connection( &mut self, _connection_id: ConnectionId, maybe_peer: Option<PeerId>, _addresses: &[Multiaddr], _effective_role: Endpoint ) -> Result<Vec<Multiaddr, Global>, ConnectionDenied>
Callback that is invoked for every outbound connection attempt. Read more
source§fn handle_established_outbound_connection(
&mut self,
_: ConnectionId,
_: PeerId,
_: &Multiaddr,
_: Endpoint
) -> Result<<<Behaviour<P> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler, ConnectionDenied>
fn handle_established_outbound_connection( &mut self, _: ConnectionId, _: PeerId, _: &Multiaddr, _: Endpoint ) -> Result<<<Behaviour<P> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler, ConnectionDenied>
Callback that is invoked for every established outbound connection. Read more
source§fn on_connection_handler_event(
&mut self,
_: PeerId,
_: ConnectionId,
ev: <<<Behaviour<P> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent
)
fn on_connection_handler_event( &mut self, _: PeerId, _: ConnectionId, ev: <<<Behaviour<P> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent )
Informs the behaviour about an event generated by the
ConnectionHandler
dedicated to the peer identified by peer_id
. for the behaviour. Read moresource§fn on_swarm_event(
&mut self,
event: FromSwarm<'_, <Behaviour<P> as NetworkBehaviour>::ConnectionHandler>
)
fn on_swarm_event( &mut self, event: FromSwarm<'_, <Behaviour<P> as NetworkBehaviour>::ConnectionHandler> )
Informs the behaviour about an event from the
Swarm
.source§fn poll(
&mut self,
cx: &mut Context<'_>,
_: &mut impl PollParameters
) -> Poll<ToSwarm<<Behaviour<P> as NetworkBehaviour>::OutEvent, <<<Behaviour<P> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::InEvent>>
fn poll( &mut self, cx: &mut Context<'_>, _: &mut impl PollParameters ) -> Poll<ToSwarm<<Behaviour<P> as NetworkBehaviour>::OutEvent, <<<Behaviour<P> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::InEvent>>
Polls for things that swarm should do. Read more
source§fn new_handler(&mut self) -> Self::ConnectionHandler
fn new_handler(&mut self) -> Self::ConnectionHandler
👎Deprecated since 0.42.0: Use one or more of
NetworkBehaviour::{handle_pending_inbound_connection,handle_established_inbound_connection,handle_pending_outbound_connection,handle_established_outbound_connection}
instead.Creates a new
ConnectionHandler
for a connection with a peer. Read moresource§fn handle_pending_inbound_connection(
&mut self,
_connection_id: ConnectionId,
_local_addr: &Multiaddr,
_remote_addr: &Multiaddr
) -> Result<(), ConnectionDenied>
fn handle_pending_inbound_connection( &mut self, _connection_id: ConnectionId, _local_addr: &Multiaddr, _remote_addr: &Multiaddr ) -> Result<(), ConnectionDenied>
Callback that is invoked for every new inbound connection. Read more
Auto Trait Implementations§
impl<P> RefUnwindSafe for Behaviour<P>where <P as Provider>::Socket: RefUnwindSafe, <P as Provider>::Timer: RefUnwindSafe, <P as Provider>::Watcher: RefUnwindSafe,
impl<P> Send for Behaviour<P>where <P as Provider>::Watcher: Send,
impl<P> Sync for Behaviour<P>where <P as Provider>::Socket: Sync, <P as Provider>::Timer: Sync, <P as Provider>::Watcher: Sync,
impl<P> Unpin for Behaviour<P>
impl<P> UnwindSafe for Behaviour<P>where <P as Provider>::Socket: UnwindSafe, <P as Provider>::Timer: UnwindSafe, <P as Provider>::Watcher: UnwindSafe,
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
Mutably borrows from an owned value. Read more