Enum libp2p::kad::Event

pub enum Event {
    InboundRequest {
        request: InboundRequest,
    },
    OutboundQueryProgressed {
        id: QueryId,
        result: QueryResult,
        stats: QueryStats,
        step: ProgressStep,
    },
    RoutingUpdated {
        peer: PeerId,
        is_new_peer: bool,
        addresses: Addresses,
        bucket_range: (Distance, Distance),
        old_peer: Option<PeerId>,
    },
    UnroutablePeer {
        peer: PeerId,
    },
    RoutablePeer {
        peer: PeerId,
        address: Multiaddr,
    },
    PendingRoutablePeer {
        peer: PeerId,
        address: Multiaddr,
    },
    ModeChanged {
        new_mode: Mode,
    },
}

Available on crate feature kad only.

The events produced by the Kademlia behaviour.

See NetworkBehaviour::poll.

Variants

InboundRequest

An inbound request has been received and handled.

Fields

request: InboundRequest

OutboundQueryProgressed

An outbound query has made progress.

Fields

id: QueryId

The ID of the query that finished.

result: QueryResult

The intermediate result of the query.

stats: QueryStats

Execution statistics from the query.

step: ProgressStep

Indicates which event this is, if therer are multiple responses for a single query.

RoutingUpdated

The routing table has been updated with a new peer and / or address, thereby possibly evicting another peer.

Fields

peer: PeerId

The ID of the peer that was added or updated.

is_new_peer: bool

Whether this is a new peer and was thus just added to the routing table, or whether it is an existing peer who’s addresses changed.

addresses: Addresses

The full list of known addresses of peer.

bucket_range: (Distance, Distance)

Returns the minimum inclusive and maximum inclusive distance for the bucket of the peer.

old_peer: Option<PeerId>

The ID of the peer that was evicted from the routing table to make room for the new peer, if any.

UnroutablePeer

A peer has connected for whom no listen address is known.

If the peer is to be added to the routing table, a known listen address for the peer must be provided via Behaviour::add_address.

Fields

peer: PeerId

RoutablePeer

A connection to a peer has been established for whom a listen address is known but the peer has not been added to the routing table either because BucketInserts::Manual is configured or because the corresponding bucket is full.

If the peer is to be included in the routing table, it must must be explicitly added via Behaviour::add_address, possibly after removing another peer.

See Behaviour::kbucket for insight into the contents of the k-bucket of peer.

Fields

peer: PeerId

address: Multiaddr

PendingRoutablePeer

A connection to a peer has been established for whom a listen address is known but the peer is only pending insertion into the routing table if the least-recently disconnected peer is unresponsive, i.e. the peer may not make it into the routing table.

If the peer is to be unconditionally included in the routing table, it should be explicitly added via Behaviour::add_address after removing another peer.

See Behaviour::kbucket for insight into the contents of the k-bucket of peer.

Fields

peer: PeerId

address: Multiaddr

ModeChanged

This peer’s mode has been updated automatically.

This happens in response to an external address being added or removed.

Fields

new_mode: Mode

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Recorder<Event> for Metrics

fn record(&self, event: &Event)

Record the given event.