rns-embedded-mininode 0.7.0

Minimal embedded Reticulum node helpers for constrained LXMF deployments.
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
61
62
63
64
65
66
67
68
69
70

use alloc::{collections::VecDeque, vec::Vec};

use crate::error::MiniNodeError;

pub trait FrameLink {
    fn is_up(&self) -> bool;
    fn mtu(&self) -> usize;
    fn send_frame(&mut self, frame: &[u8]) -> Result<(), MiniNodeError>;
    fn poll_frame(&mut self) -> Result<Option<Vec<u8>>, MiniNodeError>;
}

#[derive(Debug, Clone)]
pub struct MemoryLink {
    mtu: usize,
    online: bool,
    inbound: VecDeque<Vec<u8>>,
    outbound: VecDeque<Vec<u8>>,
}

impl Default for MemoryLink {
    fn default() -> Self {
        Self::new(512)
    }
}

impl MemoryLink {
    pub fn new(mtu: usize) -> Self {
        Self { mtu, online: true, inbound: VecDeque::new(), outbound: VecDeque::new() }
    }

    pub fn set_online(&mut self, online: bool) {
        self.online = online;
    }

    pub fn push_inbound(&mut self, frame: Vec<u8>) {
        self.inbound.push_back(frame);
    }

    pub fn drain_outbound(&mut self) -> Vec<Vec<u8>> {
        self.outbound.drain(..).collect()
    }
}

impl FrameLink for MemoryLink {
    fn is_up(&self) -> bool {
        self.online
    }

    fn mtu(&self) -> usize {
        self.mtu
    }

    fn send_frame(&mut self, frame: &[u8]) -> Result<(), MiniNodeError> {
        if !self.online {
            return Err(MiniNodeError::LinkDown);
        }
        if frame.len() > self.mtu {
            return Err(MiniNodeError::MtuExceeded { frame_len: frame.len(), mtu: self.mtu });
        }
        self.outbound.push_back(frame.to_vec());
        Ok(())
    }

    fn poll_frame(&mut self) -> Result<Option<Vec<u8>>, MiniNodeError> {
        if !self.online {
            return Ok(None);
        }
        Ok(self.inbound.pop_front())
    }
}