prns-core 0.3.4

Pure Reticulum engine and wire contract for Personal Reticulum
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

use crate::engine::InstantMillis;
use crate::interfaces::{InterfaceGravity, InterfaceId};
use crate::routing::announce::stored::{AnnounceAppData, AnnounceIdHistory, AnnounceRecordTable};
use crate::routing::announce::{Announce, AnnounceId};
use crate::routing::route_expiry::{LinearRouteExpiryIndex, RouteExpiryIndex};
use crate::routing::routes::{NextHop, RouteResponsiveness, RouteTable};
use crate::units::HopCount;

/// RNS 1.4.2's `path_table`
///
/// NOTE: `PartialEq` compares backend representation byte-for-byte because the determinism tests rely on that. Do not use `==` and expect to compare the same set of routes.
#[derive(Debug, Default, Clone, PartialEq, Eq)]
pub struct RoutingTable<R, A, H, D, I = LinearRouteExpiryIndex>
where
    R: RouteTable,
    A: AnnounceRecordTable,
    H: AnnounceIdHistory,
    D: AnnounceAppData,
    I: RouteExpiryIndex,
{
    pub(super) routes: R,
    pub(super) route_expiries: I,
    pub(super) announce_records: A,
    pub(super) announce_id_history: H,
    pub(super) announce_app_data: D,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ForwardingRoute {
    pub hops: HopCount,
    pub receiving_interface: InterfaceId,
    pub next_hop: NextHop,
}

#[derive(Debug, Clone, Copy)]
pub struct ExistingRoute<'a> {
    pub hops: HopCount,
    pub expires_at: InstantMillis,
    pub announce_id_history: &'a [AnnounceId],
    pub responsiveness: RouteResponsiveness,
    pub interface_gravity: Option<InterfaceGravity>,
}

#[derive(Debug, Clone)]
pub struct StoredAnnounce<'a> {
    pub hops: u8,
    pub receiving_interface: InterfaceId,
    pub next_hop: NextHop,
    pub announce: Announce<'a>,
}