Struct libp2p::mdns::Mdns

pub struct Mdns { /* private fields */ }

A NetworkBehaviour for mDNS. Automatically discovers peers on the local network and adds them to the topology.

Implementations

impl Mdns

pub async fn new() -> Result<Mdns, Error>

Builds a new Mdns behaviour.

pub fn has_node(&self, peer_id: &PeerId) -> bool

Returns true if the given PeerId is in the list of nodes discovered through mDNS.

pub fn discovered_nodes(&self) -> impl ExactSizeIterator

Returns the list of nodes that we have discovered through mDNS and that are not expired.

Trait Implementations

impl Debug for Mdns

pub fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl NetworkBehaviour for Mdns

type ProtocolsHandler = DummyProtocolsHandler

Handler for all the protocols the network behaviour supports.

type OutEvent = MdnsEvent

Event generated by the NetworkBehaviour and that the swarm will report back.

pub fn new_handler(&mut self) -> <Mdns as NetworkBehaviour>::ProtocolsHandler

Creates a new ProtocolsHandler for a connection with a peer.

pub fn addresses_of_peer(&mut self, peer_id: &PeerId) -> Vec<Multiaddr, Global>

Addresses that this behaviour is aware of for this specific peer, and that may allow reaching the peer.

pub fn inject_connected(&mut self, &PeerId)

Indicates the behaviour that we connected to the node with the given peer id.

pub fn inject_disconnected(&mut self, &PeerId)

Indicates the behaviour that we disconnected from the node with the given peer id.

pub fn inject_event(
    &mut self,
    PeerId,
    ConnectionId,
    ev: <<Mdns as NetworkBehaviour>::ProtocolsHandler as ProtocolsHandler>::OutEvent
)

Informs the behaviour about an event generated by the handler dedicated to the peer identified by peer_id. for the behaviour.

pub fn poll(
    &mut self,
    cx: &mut Context<'_>,
    params: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<<<Mdns as NetworkBehaviour>::ProtocolsHandler as ProtocolsHandler>::InEvent, <Mdns as NetworkBehaviour>::OutEvent>>

Polls for things that swarm should do.

fn inject_connection_established(
    &mut self,
    &PeerId,
    &ConnectionId,
    &ConnectedPoint
)

Informs the behaviour about a newly established connection to a peer.

fn inject_connection_closed(&mut self, &PeerId, &ConnectionId, &ConnectedPoint)

Informs the behaviour about a closed connection to a peer.

fn inject_address_change(
    &mut self,
    &PeerId,
    &ConnectionId,
    _old: &ConnectedPoint,
    _new: &ConnectedPoint
)

Informs the behaviour that the ConnectedPoint of an existing connection has changed.

fn inject_addr_reach_failure(
    &mut self,
    _peer_id: Option<&PeerId>,
    _addr: &Multiaddr,
    _error: &dyn Error
)

Indicates to the behaviour that we tried to reach an address, but failed.

fn inject_dial_failure(&mut self, _peer_id: &PeerId)

Indicates to the behaviour that we tried to dial all the addresses known for a node, but failed.

fn inject_new_listen_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that we have started listening on a new multiaddr.

fn inject_expired_listen_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that a new multiaddr we were listening on has expired, which means that we are no longer listening in it.

fn inject_new_external_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that we have discovered a new external address for us.

fn inject_listener_error(
    &mut self,
    _id: ListenerId,
    _err: &(dyn Error + 'static)
)

A listener experienced an error.

fn inject_listener_closed(
    &mut self,
    _id: ListenerId,
    _reason: Result<(), &Error>
)

A listener closed.