antenna-protocol 0.1.1

SansIO core driving the antenna P2P mesh protocol.
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

use crate::{
    MsgPayload, PeerID, Scheduled, SignalingPayload, UserMsgPayload, handshake::HandshakeOutput,
};

/// Common event that client FSM sends
#[derive(Debug, Clone)]
pub enum Output<Msg: UserMsgPayload> {
    /// Handshake event for a known peer
    Handshake {
        peer: PeerID,
        event: HandshakeOutput,
    },

    /// Bootstrap host: create an open offer (joiner peer ID not yet known)
    InitOpenOffer,

    /// Bootstrap host: open offer SDP is ready to be shared out-of-band with a joiner
    OfferReady(SignalingPayload),

    /// Bootstrap joiner: SDP answer is ready to be shared out-of-band with the host
    AnswerReady(SignalingPayload),

    /// Send message to other peer in mesh
    SendMessage {
        peer_to: PeerID,
        data: MsgPayload<Msg>,
    },

    /// Initiate receiving message from any outer sender
    ReceiveMessage {
        peer_from: PeerID,
        data: MsgPayload<Msg>,
    },

    /// Notify about new peer connected to mesh
    PeerConnected { peer: PeerID },

    /// Notify about peer that gracefully left the mesh
    PeerDisconnected { peer: PeerID },

    /// Notify about peer lost due to connection failure (abrupt, candidate for reconnect)
    PeerLost { peer: PeerID },

    /// Node-level status: first peer reached `Connected` (FSMState: Init → Connected).
    Connected,

    /// Node-level status: all relay handshakes complete (FSMState: Connected → Available).
    Available,

    /// Node-level status: a relay handshake is in progress or no peers are connected
    /// (FSMState: Available → Connected, or any → Init).
    Unavailable,

    /// Local node sent disconnect notices to all peers; driver must close all connections
    /// (FSMState: anything → Left).
    Disconnecting,

    /// Driver should schedule a timer
    ScheduleTimer { kind: Scheduled, after_ms: u64 },
}