Struct PeerDb 

pub struct PeerDb { /* private fields */ }

A database that stores a map of peers by PeerId and multiple indices.

Assumes that all indexed fields are unique per-node, with a few notable exceptions:

• Hostname may be duplicated, though the fqdn (including the tailnet component) may not be.
• Accepted routes may overlap.

Implementations

impl PeerDb

pub fn upsert(&mut self, new: &Node) -> PeerId

Upsert a node into the peer db.

The StableNodeId is used as the primary key to identify the node.

pub fn remove(&mut self, field: &dyn IndexedField) -> Option<(PeerId, Node)>

Remove a peer by a given indexed field.

pub fn get(&self, field: &dyn IndexedField) -> Option<(PeerId, &Node)>

Get the node with the given field.

pub fn get_route(&self, route: IpNet) -> impl Iterator<Item = (PeerId, &Node)>

Get the nodes with the closest matching route.

pub fn has(&self, field: &dyn IndexedField) -> Option<PeerId>

Check whether there is a peer with the given field in the db.

pub fn peer_by_known_disco_key( &self, key: &DiscoPublicKey, ) -> Option<(PeerId, &Node, DiscoKeyMatch)>

Resolve an inbound disco frame’s sender key to the peer that owns it, accepting either of that peer’s two known disco keys — Go endpoint.checkAndUpdateDiscoKey.

The active key is tried first, so a key that is one peer’s active key and another peer’s stale inactive one resolves to the peer that is actually using it. A key belonging to neither slot of any peer returns None and must be refused by the caller: that refusal is what stops an unknown disco key from opening a path or being attributed to a peer.

Two peers can transiently claim the same key under netmap churn (see disco_key_reassigned_across_peers_no_panic); like every other index here the answer is the last writer’s, never a panic.

pub fn set_inactive_disco_key( &mut self, id: PeerId, key: Option<DiscoPublicKey>, )

Register (or clear) the peer’s known-but-inactive disco key, so ingress under it still resolves to the peer.

A control Node carries a single disco key, so the second slot of Go’s endpointDisco cannot come in through upsert; the peer tracker — which owns that state — writes it here immediately after each upsert. Passing None retracts the entry, which is what a peer that has only ever had one key needs.

pub const fn peers(&self) -> &HashMap<PeerId, Node>

Get a reference to the peer map.

pub fn retain(&mut self, predicate: impl FnMut(PeerId, &Node) -> bool)

Remove the nodes in the db that don’t satisfy the predicate function.

Trait Implementations

impl Clone for PeerDb

fn clone(&self) -> PeerDb

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PeerDb

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

Formats the value using the given formatter.

impl Default for PeerDb

fn default() -> PeerDb

Returns the “default value” for a type.