prns-runtime 0.3.6

Runtime-neutral Personal Reticulum node contracts and manifold kernel
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

use crate::engine::{
    AnnounceAppData, AnnounceNow, AnnounceTarget, CommandId, PacketReceiptDelivered, PrnsCommand,
    SendSinglePacketFailure,
};
pub use crate::engine::{DropRouteOutcome, DropRoutesViaOutcome};
use crate::identity::{
    IdentityHash, MarkDestinationUsedOutcome, ReleaseDestinationOutcome, RetainDestinationOutcome,
    RetainIdentityOutcome,
};
use crate::routing::links::LinkId;
use crate::wire::{DestinationHash, TransportId};

use super::request_endpoints::RespondToken;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ClearAnnounceQueuesOutcome {
    pub dropped_announces: u32,
}

/// Why an awaited send never reached `Delivered`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SendError<F> {
    PayloadTooLarge,
    NodeStopped,
    /// More awaited sends are in flight than the platform tracks at once
    Busy,
    Failed(F),
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RoutingControlError {
    NodeStopped,
    Busy,
}

pub trait RoutingControl {
    fn drop_route(
        &self,
        destination: DestinationHash,
    ) -> impl core::future::Future<Output = Result<DropRouteOutcome, RoutingControlError>> + Send;

    fn drop_routes_via(
        &self,
        transport: TransportId,
    ) -> impl core::future::Future<Output = Result<DropRoutesViaOutcome, RoutingControlError>> + Send;

    fn clear_announce_queues(
        &self,
    ) -> impl core::future::Future<Output = Result<ClearAnnounceQueuesOutcome, RoutingControlError>> + Send;
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DestinationIdentityRetentionControlError {
    NodeStopped,
    Busy,
}

pub trait DestinationIdentityRetentionControl {
    fn mark_destination_used(
        &self,
        destination: DestinationHash,
    ) -> impl core::future::Future<
        Output = Result<MarkDestinationUsedOutcome, DestinationIdentityRetentionControlError>,
    > + Send;

    fn retain_destination(
        &self,
        destination: DestinationHash,
    ) -> impl core::future::Future<
        Output = Result<RetainDestinationOutcome, DestinationIdentityRetentionControlError>,
    > + Send;

    fn release_destination(
        &self,
        destination: DestinationHash,
    ) -> impl core::future::Future<
        Output = Result<ReleaseDestinationOutcome, DestinationIdentityRetentionControlError>,
    > + Send;

    fn retain_identity(
        &self,
        identity: IdentityHash,
    ) -> impl core::future::Future<
        Output = Result<RetainIdentityOutcome, DestinationIdentityRetentionControlError>,
    > + Send;
}

/// The high-level API shared by every platform's node handle. Tokio carries commands over an unbounded channel with per-command oneshots; Embassy uses a bounded channel and static completion pool.
///
/// [`issue`](Self::issue) returns a minted [`CommandId`] immediately, while awaited operations settle through that id. Platform-specific capabilities remain inherent methods on the concrete handle.
#[allow(async_fn_in_trait)]
pub trait PrnsNodeApi {
    /// Queues an engine command and returns the [`CommandId`] it was minted under. If you're looking for its settlement, watch the event stream for the settlement tagged with that CommandId.
    ///
    /// You may not ever need this, since many operations have their own convenience methods, usually `await`able.
    fn issue(&self, command: PrnsCommand) -> Option<CommandId>;

    /// Announce `destination` on every interface with its registered app_data: RNS 1.4.2 `Destination.announce()` with no arguments.
    ///
    /// Returns `None` if the node has stopped. If you want to target a specific interface or provide explicit app_data, [`issue`](Self::issue) a custom [`AnnounceNow`]. Some platform implementations may provide an awaitable convenience method, specifically for `announce_now`, on top of this.
    fn announce(&self, destination: DestinationHash) -> Option<CommandId> {
        self.issue(PrnsCommand::AnnounceNow(AnnounceNow {
            destination,
            target: AnnounceTarget::AllInterfaces,
            app_data: AnnounceAppData::Registered,
        }))
    }

    async fn send_single_packet(
        &self,
        destination: DestinationHash,
        data: &[u8],
    ) -> Result<PacketReceiptDelivered, SendError<SendSinglePacketFailure>>;

    fn respond_packed(&self, responder: RespondToken, packed: &[u8]) -> bool;

    fn close_link(&self, link_id: LinkId) -> bool;
}