antenna-protocol 0.1.0

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

use crate::{
    HandshakeMode, HandshakeStrategy, PeerID, Scheduled, UserMsgPayload, handshake::HandshakeInput,
    state::MsgPayload,
};

/// Common event that client FSM receives
#[derive(Debug, Clone)]
pub enum Input<Msg: UserMsgPayload> {
    /// Initiate a handshake with a known peer ID, choosing role and signaling mode.
    InitHandshake {
        with: PeerID,
        mode: HandshakeMode,
        strategy: HandshakeStrategy,
    },

    /// Bootstrap host initializes an open offer without knowing the joiner's ID yet.
    InitOpenOffer,

    /// Bootstrap host's SDP offer was created by WebRTC.
    OpenOfferCreated(String),

    /// Receive handshake event from a known peer
    Handshake { from: PeerID, event: HandshakeInput },

    /// Receive abstract message
    MessageReceived {
        peer_from: PeerID,
        data: MsgPayload<Msg>,
    },

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

    /// Send abstract message to all peers
    Broadcast { data: MsgPayload<Msg> },

    /// Receive peer leaving message
    PeerLeaving { peer: PeerID },

    /// The local node initiates departure from the mesh
    Leave,

    /// Driver-scheduled timer expired; FSM dispatches by kind.
    TimerFired { kind: Scheduled },
}