kitsune2_api 0.5.0-dev.1

p2p / dht communication framework api
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! Known-peers index types.
//!
//! The [`KnownPeers`] trait provides an append-only index of all ever-seen
//! agent infos, including those that are currently blocked.  It is used
//! purely for URL → agent-ID resolution by the access control layer so that
//! a blocked agent cannot slip through just because it shares a URL with a
//! non-blocked agent.

use crate::*;
use std::sync::Arc;

/// An append-only index of all ever-seen agent infos, including blocked ones.
///
/// Unlike [`PeerStore`] this store never removes entries on blocking – its
/// only purpose is to let the access control layer answer the question
/// "which agents have we ever seen at this URL?".
pub trait KnownPeers: 'static + Send + Sync + std::fmt::Debug {
    /// Record agent infos without any block filtering.
    ///
    /// This should be called with every batch of agent infos *before* any
    /// block filter is applied, so that blocked agents remain discoverable
    /// by URL.
    fn record(
        &self,
        agent_infos: Vec<Arc<AgentInfoSigned>>,
    ) -> BoxFut<'_, K2Result<()>>;

    /// Look up all known agent IDs reachable at the given URL, regardless of
    /// their current block status.
    fn get_by_url(&self, url: Url) -> BoxFut<'_, K2Result<Vec<AgentId>>>;
}

/// Trait-object [`KnownPeers`].
pub type DynKnownPeers = Arc<dyn KnownPeers>;

/// A factory for constructing [`KnownPeers`] instances.
pub trait KnownPeersFactory: 'static + Send + Sync + std::fmt::Debug {
    /// Help the builder construct a default config from the chosen
    /// module factories.
    fn default_config(&self, config: &mut Config) -> K2Result<()>;

    /// Validate configuration.
    fn validate_config(&self, config: &Config) -> K2Result<()>;

    /// Construct a [`KnownPeers`] instance.
    fn create(
        &self,
        builder: Arc<Builder>,
        space_id: SpaceId,
    ) -> BoxFut<'static, K2Result<DynKnownPeers>>;
}

/// Trait-object [`KnownPeersFactory`].
pub type DynKnownPeersFactory = Arc<dyn KnownPeersFactory>;