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
63
64
65
66
67
68
69
70
71
72

use super::protocol::{DataPlanePlan, GoIntent, GroupRole, Initiative, PeerEvidence};
use crate::interfaces::MacAddress;

#[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 GroupEndReason {
    PeerRemoved,
    LocalRemoved,
    LinkLost,
    Revoked(&'static str),
}

pub enum WifiDirectEvent<G> {
    Sighting {
        peer: MacAddress,
        evidence: PeerEvidence,
        initiative: Initiative,
    },
    PeerGone {
        peer: MacAddress,
    },
    Invitation {
        peer: MacAddress,
    },
    GroupOffer {
        peer: MacAddress,
    },
    GroupFormed {
        group: G,
    },
    GroupLost {
        reason: GroupEndReason,
    },
    FormationFailed {
        peer: MacAddress,
    },
    FormationProgress,
    AvailabilityChanged(Availability),
}

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

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

    async fn set_discovery(&mut self, mode: DiscoveryMode) -> Result<(), Self::Error>;
    async fn form_group(&mut self, peer: MacAddress, intent: GoIntent);
    async fn accept_invitation(&mut self, peer: MacAddress, intent: GoIntent);
    async fn join_group(&mut self, _peer: MacAddress) {}
    async fn remove_group(&mut self);
    async fn next_event(&mut self) -> WifiDirectEvent<Self::Group>;
}

pub trait WifiDirectGroup {
    fn role(&self) -> GroupRole;
    fn data_plane(&self) -> DataPlanePlan;
}