viewstamped-replication 0.2.0

A Rust-based implementation of the Viewstamped Replication consensus 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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

use std::collections::hash_map::Entry;
use std::collections::HashMap;
use std::io;
use std::net::SocketAddr;
use std::sync::{Arc, mpsc, RwLock};
use std::sync::mpsc::TryRecvError;
use crate::model::Message;


#[derive(Clone, Debug, Default)]
pub struct Network {
    outbound: Arc<RwLock<HashMap<SocketAddr, mpsc::Sender<(SocketAddr, Message)>>>>,
}

impl Network {
    pub fn bind(&mut self, address: SocketAddr) -> io::Result<CommunicationStream> {
        let mut guard = self.outbound.write().unwrap_or_else(|e| {
            let mut guard = e.into_inner();
            *guard = HashMap::new();
            guard
        });

        match guard.entry(address) {
            Entry::Occupied(_) => {
                Err(io::Error::from(io::ErrorKind::AddrInUse))
            }
            Entry::Vacant(entry) => {
                let (outbound, inbound) = mpsc::channel();
                let network = self.clone();

                entry.insert(outbound);

                Ok(CommunicationStream { address, inbound, network })
            }
        }
    }

    pub fn connect(&self, to: SocketAddr) -> io::Result<mpsc::Sender<(SocketAddr, Message)>> {
        let guard = self.outbound.read().map_err(|_| io::Error::from(io::ErrorKind::AddrNotAvailable))?;

        guard.get(&to).cloned().ok_or_else(|| io::Error::from(io::ErrorKind::AddrNotAvailable))
    }
}

#[derive(Debug)]
pub struct CommunicationStream {
    address: SocketAddr,
    inbound: mpsc::Receiver<(SocketAddr, Message)>,
    network: Network,
}

impl CommunicationStream {
    pub fn receive(&mut self) -> io::Result<(SocketAddr, Message)> {
        self.inbound.try_recv().map_err(|e| match e {
            TryRecvError::Empty => io::Error::from(io::ErrorKind::WouldBlock),
            TryRecvError::Disconnected => io::Error::from(io::ErrorKind::ConnectionAborted),
        })
    }

    pub fn send(&mut self, to: SocketAddr, message: Message) -> io::Result<()> {
        let outbound = self.network.connect(to)?;

        outbound.send((self.address, message)).map_err(|_| io::Error::from(io::ErrorKind::ConnectionReset))
    }
}


#[cfg(test)]
mod tests {
    use crate::model::{Prepare, Request};
    use super::*;

    #[test]
    fn basic() {
        let mut network = Network::default();
        let a = "127.0.0.1:3001".parse().unwrap();
        let b = "127.0.0.1:3002".parse().unwrap();

        let mut a_stream = network.bind(a).unwrap();
        let mut b_stream = network.bind(b).unwrap();

        let message = Message::Prepare(Prepare {
            v: 1,
            n: 1,
            m: Request {
                op: b"Hello, World!".to_vec(),
                c: 1,
                s: 1,
                v: 0,
            },
        });

        a_stream.send(b, message.clone()).unwrap();

        assert_eq!(b_stream.receive().unwrap(), (a, message));
    }
}