p2panda_net/discovery/
api.rs

1// SPDX-License-Identifier: MIT OR Apache-2.0
2
3use std::sync::Arc;
4
5use ractor::{ActorRef, call};
6use thiserror::Error;
7use tokio::sync::{RwLock, broadcast};
8
9use crate::address_book::AddressBook;
10use crate::discovery::actors::{DiscoveryManagerArgs, ToDiscoveryManager};
11use crate::discovery::events::DiscoveryEvent;
12use crate::discovery::{Builder, DiscoveryMetrics};
13use crate::iroh_endpoint::Endpoint;
14
15/// Confidential topic discovery and random-walk strategy to resolve transport infos.
16///
17/// ## Design
18///
19/// Read more about the underlying design in [`p2panda-discovery`].
20///
21/// [`p2panda-discovery`]: https://docs.rs/p2panda-discovery/latest/p2panda_discovery/
22#[derive(Clone)]
23pub struct Discovery {
24    #[allow(unused, reason = "used by supervisor behind feature flag")]
25    pub(super) args: DiscoveryManagerArgs,
26    pub(super) inner: Arc<RwLock<Inner>>,
27}
28
29pub(super) struct Inner {
30    pub(super) actor_ref: Option<ActorRef<ToDiscoveryManager>>,
31}
32
33impl Discovery {
34    pub(crate) fn new(
35        actor_ref: Option<ActorRef<ToDiscoveryManager>>,
36        args: DiscoveryManagerArgs,
37    ) -> Self {
38        Self {
39            args,
40            inner: Arc::new(RwLock::new(Inner { actor_ref })),
41        }
42    }
43
44    pub fn builder(address_book: AddressBook, endpoint: Endpoint) -> Builder {
45        Builder::new(address_book, endpoint)
46    }
47
48    /// Subscribe to system events.
49    pub async fn events(&self) -> Result<broadcast::Receiver<DiscoveryEvent>, DiscoveryError> {
50        let inner = self.inner.read().await;
51        let result = call!(
52            inner.actor_ref.as_ref().expect("actor spawned in builder"),
53            ToDiscoveryManager::Events
54        )
55        .map_err(Box::new)?;
56        Ok(result)
57    }
58
59    /// Returns current metrics.
60    pub async fn metrics(&self) -> Result<DiscoveryMetrics, DiscoveryError> {
61        let inner = self.inner.read().await;
62        let result = call!(
63            inner.actor_ref.as_ref().expect("actor spawned in builder"),
64            ToDiscoveryManager::Metrics
65        )
66        .map_err(Box::new)?;
67        Ok(result)
68    }
69}
70
71impl Drop for Inner {
72    fn drop(&mut self) {
73        if let Some(actor_ref) = self.actor_ref.take() {
74            actor_ref.stop(None);
75        }
76    }
77}
78
79#[derive(Debug, Error)]
80pub enum DiscoveryError {
81    /// Spawning the internal actor failed.
82    #[error(transparent)]
83    ActorSpawn(#[from] ractor::SpawnErr),
84
85    /// Spawning the internal actor as a child actor of a supervisor failed.
86    #[cfg(feature = "supervisor")]
87    #[error(transparent)]
88    ActorLinkedSpawn(#[from] crate::supervisor::SupervisorError),
89
90    /// Messaging with internal actor via RPC failed.
91    #[error(transparent)]
92    ActorRpc(#[from] Box<ractor::RactorErr<ToDiscoveryManager>>),
93}
p2panda_net/discovery/api.rs

p2panda_net/discovery/
api.rs
