Struct Behaviour
pub struct Behaviour<P>where
P: Provider,{ /* private fields */ }
Available on crate feature
mdns
only.Expand description
A NetworkBehaviour
for mDNS. Automatically discovers peers on the local network and adds
them to the topology.
Implementations§
§impl<P> Behaviour<P>where
P: Provider,
impl<P> Behaviour<P>where
P: Provider,
pub fn new(config: Config, local_peer_id: PeerId) -> Result<Behaviour<P>, Error>
Available on crate feature async-io
only.
pub fn new(config: Config, local_peer_id: PeerId) -> Result<Behaviour<P>, Error>
async-io
only.Builds a new Mdns
behaviour.
pub fn has_node(&self, peer_id: &PeerId) -> bool
👎Deprecated: Use discovered_nodes
iterator instead.Available on crate feature async-io
only.
pub fn has_node(&self, peer_id: &PeerId) -> bool
discovered_nodes
iterator instead.async-io
only.Returns true if the given PeerId
is in the list of nodes discovered through mDNS.
pub fn discovered_nodes(&self) -> impl ExactSizeIterator
Available on crate feature async-io
only.
pub fn discovered_nodes(&self) -> impl ExactSizeIterator
async-io
only.Returns the list of nodes that we have discovered through mDNS and that are not expired.
pub fn expire_node(&mut self, peer_id: &PeerId)
👎Deprecated: Unused API. Will be removed in the next release.Available on crate feature async-io
only.
pub fn expire_node(&mut self, peer_id: &PeerId)
async-io
only.Expires a node before the ttl.
Trait Implementations§
§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.
§fn handle_established_inbound_connection(
&mut self,
_: ConnectionId,
_: PeerId,
_: &Multiaddr,
_: &Multiaddr,
) -> Result<<Behaviour<P> as NetworkBehaviour>::ConnectionHandler, ConnectionDenied>
fn handle_established_inbound_connection( &mut self, _: ConnectionId, _: PeerId, _: &Multiaddr, _: &Multiaddr, ) -> Result<<Behaviour<P> as NetworkBehaviour>::ConnectionHandler, ConnectionDenied>
Callback that is invoked for every established inbound connection. Read more
§fn handle_pending_outbound_connection(
&mut self,
_connection_id: ConnectionId,
maybe_peer: Option<PeerId>,
_addresses: &[Multiaddr],
_effective_role: Endpoint,
) -> Result<Vec<Multiaddr>, ConnectionDenied>
fn handle_pending_outbound_connection( &mut self, _connection_id: ConnectionId, maybe_peer: Option<PeerId>, _addresses: &[Multiaddr], _effective_role: Endpoint, ) -> Result<Vec<Multiaddr>, ConnectionDenied>
Callback that is invoked for every outbound connection attempt. Read more
§fn handle_established_outbound_connection(
&mut self,
_: ConnectionId,
_: PeerId,
_: &Multiaddr,
_: Endpoint,
_: PortUse,
) -> Result<<Behaviour<P> as NetworkBehaviour>::ConnectionHandler, ConnectionDenied>
fn handle_established_outbound_connection( &mut self, _: ConnectionId, _: PeerId, _: &Multiaddr, _: Endpoint, _: PortUse, ) -> Result<<Behaviour<P> as NetworkBehaviour>::ConnectionHandler, ConnectionDenied>
Callback that is invoked for every established outbound connection. Read more
§fn on_connection_handler_event(
&mut self,
_: PeerId,
_: ConnectionId,
ev: <<Behaviour<P> as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::ToBehaviour,
)
fn on_connection_handler_event( &mut self, _: PeerId, _: ConnectionId, ev: <<Behaviour<P> as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::ToBehaviour, )
Informs the behaviour about an event generated by the
ConnectionHandler
dedicated to the peer identified by peer_id
. for the behaviour. Read more§fn on_swarm_event(&mut self, event: FromSwarm<'_>)
fn on_swarm_event(&mut self, event: FromSwarm<'_>)
Informs the behaviour about an event from the
Swarm
.§fn poll(
&mut self,
cx: &mut Context<'_>,
) -> Poll<ToSwarm<<Behaviour<P> as NetworkBehaviour>::ToSwarm, <<Behaviour<P> as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::FromBehaviour>>
fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<ToSwarm<<Behaviour<P> as NetworkBehaviour>::ToSwarm, <<Behaviour<P> as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::FromBehaviour>>
Polls for things that swarm should do. Read more
§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> Freeze for Behaviour<P>
impl<P> !RefUnwindSafe for Behaviour<P>
impl<P> Send for Behaviour<P>
impl<P> Sync for Behaviour<P>
impl<P> Unpin for Behaviour<P>where
<P as Provider>::TaskHandle: Unpin,
impl<P> !UnwindSafe for Behaviour<P>
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more