paxakos 0.1.0

Rust implementation of Paxos consensus algorithm
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

use std::sync::Arc;

use futures::future::LocalBoxFuture;

use crate::{CoordNum, LogEntry, NodeInfo, Promise, Rejection, RoundNum};

pub type CoordNumOf<C> = <C as Communicator>::CoordNum;
pub type ErrorOf<C> = <C as Communicator>::Error;
pub type RoundNumOf<C> = <C as Communicator>::RoundNum;

pub trait Communicator: 'static {
    type Node: NodeInfo;

    type RoundNum: RoundNum;
    type CoordNum: CoordNum;

    type LogEntry: LogEntry;

    type Error: std::error::Error + Send + Sync + 'static;

    fn send_prepare<'a>(
        &mut self,
        receivers: &'a [Self::Node],
        round_num: Self::RoundNum,
        coord_num: Self::CoordNum,
    ) -> Vec<(
        &'a Self::Node,
        LocalBoxFuture<
            'static,
            Result<PromiseOrRejection<Self::RoundNum, Self::CoordNum, Self::LogEntry>, Self::Error>,
        >,
    )>;

    fn send_proposal<'a>(
        &mut self,
        receivers: &'a [Self::Node],
        round_num: Self::RoundNum,
        coord_num: Self::CoordNum,
        log_entry: Arc<Self::LogEntry>,
    ) -> Vec<(
        &'a Self::Node,
        LocalBoxFuture<
            'static,
            Result<AcceptanceOrRejection<Self::CoordNum, Self::LogEntry>, Self::Error>,
        >,
    )>;

    fn send_commit<'a>(
        &mut self,
        receivers: &'a [Self::Node],
        round_num: Self::RoundNum,
        log_entry: Arc<Self::LogEntry>,
    ) -> Vec<(
        &'a Self::Node,
        LocalBoxFuture<'static, Result<(), Self::Error>>,
    )>;

    fn send_commit_by_id<'a>(
        &mut self,
        receivers: &'a [Self::Node],
        round_num: Self::RoundNum,
        log_entry_id: <Self::LogEntry as LogEntry>::Id,
    ) -> Vec<(
        &'a Self::Node,
        LocalBoxFuture<'static, Result<(), Self::Error>>,
    )>;
}

#[derive(Clone, Debug)]
pub enum PromiseOrRejection<R, C, E>
where
    R: RoundNum,
    C: CoordNum,
    E: LogEntry,
{
    Promise(Promise<R, C, E>),
    Rejection(Rejection<C, E>),
}

#[derive(Clone, Debug)]
pub enum AcceptanceOrRejection<C, E>
where
    C: CoordNum,
    E: LogEntry,
{
    Acceptance,
    Rejection(Rejection<C, E>),
}