Struct libp2p_kad::Kademlia

pub struct Kademlia<TSubstream> { /* fields omitted */ }

Network behaviour that handles Kademlia.

Methods

impl<TSubstream> Kademlia<TSubstream>

pub fn new(local_peer_id: PeerId) -> Self

Creates a Kademlia.

pub fn without_init(local_peer_id: PeerId) -> Self

Deprecated:

this function is now equivalent to new() and will be removed in the future

Creates a Kademlia.

Contrary to new, doesn't perform the initialization queries that store our local ID into the DHT and fill our buckets.

pub fn add_connected_address(&mut self, peer_id: &PeerId, address: Multiaddr)

Adds a known address for the given PeerId. We are connected to this address.

pub fn add_not_connected_address(
    &mut self,
    peer_id: &PeerId,
    address: Multiaddr
)

Adds a known address for the given PeerId. We are not connected or don't know whether we are connected to this address.

pub fn kbuckets_entries(&self) -> impl Iterator<Item = &PeerId>

Returns an iterator to all the peer IDs in the bucket, without the pending nodes.

pub fn find_node(&mut self, peer_id: PeerId)

Starts an iterative FIND_NODE request.

This will eventually produce an event containing the nodes of the DHT closest to the requested PeerId.

pub fn get_providers(&mut self, target: Multihash)

Starts an iterative GET_PROVIDERS request.

pub fn add_providing(&mut self, key: PeerId)

Register the local node as the provider for the given key.

This will periodically send ADD_PROVIDER messages to the nodes closest to the key. When someone performs a GET_PROVIDERS iterative request on the DHT, our local node will be returned as part of the results.

The actual meaning of providing the value of a key is not defined, and is specific to the value whose key is the hash.

pub fn remove_providing(&mut self, key: &Multihash)

Cancels a registration done with add_providing.

There doesn't exist any "remove provider" message to broadcast on the network, therefore we will still be registered as a provider in the DHT for as long as the timeout doesn't expire.

Trait Implementations

impl<TSubstream> NetworkBehaviour for Kademlia<TSubstream> where
    TSubstream: AsyncRead + AsyncWrite, 

type ProtocolsHandler = KademliaHandler<TSubstream, QueryId>

Handler for all the protocols the network supports.

type OutEvent = KademliaOut

Event generated by the swarm.

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

Creates a new ProtocolsHandler for a connection with a peer.

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

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

fn inject_connected(&mut self, id: PeerId, endpoint: ConnectedPoint)

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

fn inject_addr_reach_failure(
    &mut self,
    peer_id: Option<&PeerId>,
    addr: &Multiaddr,
    _: &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_disconnected(&mut self, id: &PeerId, _old_endpoint: ConnectedPoint)

Indicates the behaviour that we disconnected from the node with the given peer id. The endpoint is the one we used to be connected to.

fn inject_replaced(
    &mut self,
    peer_id: PeerId,
    _old: ConnectedPoint,
    new_endpoint: ConnectedPoint
)

Indicates the behaviour that we replace the connection from the node with another.

fn inject_node_event(
    &mut self,
    source: PeerId,
    event: KademliaHandlerEvent<QueryId>
)

Indicates the behaviour that the node with the given peer id has generated an event for us.

fn poll(
    &mut self,
    parameters: &mut PollParameters
) -> Async<NetworkBehaviourAction<<Self::ProtocolsHandler as ProtocolsHandler>::InEvent, Self::OutEvent>>

Polls for things that swarm should do.

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.