ratman 0.0.0

A delay tolerant, journaled and distributed userspace packet router
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

//! Protocol generation module
//!
//! The routing protocol, and micro messages (analogous to micro
//! code), are much better documented in the `R.A.T.M.A.N.` design
//! specification/paper. But here's a brief overview, and
//! implementation:
//!
//! - `Announce` is sent when a node comes online
//! - `Sync` is a reply to an `Announce`, only omitted when `no_sync` is set

use crate::data::{Message, MsgId};
use identity::Identity;
use netmod::Recipient;
use serde::{Deserialize, Serialize};

const ASSOCIATOR: &'static str = ".internal";

/// A payload that represents a RATMAN-protocol message
#[derive(Serialize, Deserialize)]
pub(crate) enum ProtoPayload {
    /// A network-wide announcement message
    Announce { id: Identity, no_sync: bool },
    /// A 1-to-1 routing table sync message
    Sync { id: Identity, table: Vec<Identity> },
}

/// Provide a builder API to construct different types of Messages
pub struct Protocol;

impl Protocol {
    /// Build an announcement message for a user
    pub fn announce(sender: Identity) -> Message {
        Message::build_signed(
            MsgId([0; 16]),
            sender,
            Recipient::Flood,
            vec![0],
        )
    }

    /// Build a message that synchronises routing table state
    pub fn sync_rt(sender: Identity, recipient: Identity, _known: Vec<Identity>) -> Message {
        Message::build_signed(
            MsgId([0; 16]),
            sender.clone(),
            Recipient::User(recipient),
            vec![0],
            // ProtoPayload::Sync {
            //     id: sender,
            //     table: known,
            // },
        )
    }
}