Struct libp2p_identify::Identify

pub struct Identify { /* private fields */ }

Network behaviour that automatically identifies nodes periodically, returns information about them, and answers identify queries from other nodes.

All external addresses of the local node supposedly observed by remotes are reported via NetworkBehaviourAction::ReportObservedAddr with a score of 1.

Implementations

impl Identify

pub fn new(config: IdentifyConfig) -> Self

Creates a new Identify network behaviour.

pub fn push<I>(&mut self, peers: I) where
    I: IntoIterator<Item = PeerId>, 

Initiates an active push of the local peer information to the given peers.

Trait Implementations

impl NetworkBehaviour for Identify

type ConnectionHandler = IdentifyHandlerProto

Handler for all the protocols the network behaviour supports.

type OutEvent = IdentifyEvent

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

fn new_handler(&mut self) -> Self::ConnectionHandler

Creates a new ConnectionHandler for a connection with a peer.

fn inject_connection_established(
    &mut self,
    peer_id: &PeerId,
    conn: &ConnectionId,
    endpoint: &ConnectedPoint,
    failed_addresses: Option<&Vec<Multiaddr>>,
    _other_established: usize
)

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

fn inject_connection_closed(
    &mut self,
    peer_id: &PeerId,
    conn: &ConnectionId,
    _: &ConnectedPoint,
    _: <Self::ConnectionHandler as IntoConnectionHandler>::Handler,
    remaining_established: usize
)

Informs the behaviour about a closed connection to a peer.

fn inject_dial_failure(
    &mut self,
    peer_id: Option<PeerId>,
    _: Self::ConnectionHandler,
    error: &DialError
)

Indicates to the behaviour that the dial to a known or unknown node failed.

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

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

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

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

fn inject_event(
    &mut self,
    peer_id: PeerId,
    connection: ConnectionId,
    event: <<Self::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent
)

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

fn poll(
    &mut self,
    cx: &mut Context<'_>,
    params: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<Self::OutEvent, Self::ConnectionHandler>>

Polls for things that swarm should do.

fn addresses_of_peer(&mut self, peer: &PeerId) -> Vec<Multiaddr>

Addresses that this behaviour is aware of for this specific peer, and that may allow reaching the 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_listen_failure(
    &mut self,
    _local_addr: &Multiaddr,
    _send_back_addr: &Multiaddr,
    _handler: Self::ConnectionHandler
)

Indicates to the behaviour that an error happened on an incoming connection during its initial handshake.

fn inject_new_listener(&mut self, _id: ListenerId)

Indicates to the behaviour that a new listener was created.

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.

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_expired_external_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that an external address was removed.