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
51
52
53
54
55
56
57
58
59
60
61
62

use super::protocol::{AwareEndpoint, NdpRole, RendezvousToken};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Availability {
    Available,
    Unavailable(&'static str),
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DiscoveryMode {
    On,
    Off,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum NdpEndReason {
    PeerGone,
    LocalClosed,
    LinkLost,
    Revoked(&'static str),
}

pub enum WifiAwareEvent {
    PeerDiscovered {
        peer: RendezvousToken,
    },
    NdpRequested {
        peer: RendezvousToken,
    },
    DataPathUp {
        peer: RendezvousToken,
        role: NdpRole,
        endpoint: AwareEndpoint,
    },
    DataPathDown {
        peer: RendezvousToken,
        role: NdpRole,
        reason: NdpEndReason,
    },
    NdpFailed {
        peer: RendezvousToken,
        role: NdpRole,
    },
    AvailabilityChanged(Availability),
}

#[allow(async_fn_in_trait)]
pub trait WifiAwareBackend {
    type Error: core::fmt::Debug;

    fn blocked(&self) -> Option<&'static str> {
        None
    }

    /// The backend owns the token so the published value and the keeper-duel rank cannot diverge.
    fn local_token(&self) -> RendezvousToken;

    async fn set_discovery(&mut self, mode: DiscoveryMode) -> Result<(), Self::Error>;
    async fn request_data_path(&mut self, peer: RendezvousToken, role: NdpRole);
    async fn abandon_data_path(&mut self, peer: RendezvousToken, role: NdpRole);
    async fn next_event(&mut self) -> WifiAwareEvent;
}