augrim 0.1.2

Augrim is a library of consensus algorithms implemented in Rust.
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

// Copyright 2021-2022 Cargill Incorporated
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::process::Process;
use crate::time::Time;

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Participant<P> {
    pub process: P,
    pub vote: Option<bool>,
    pub decision_ack: bool,
}

impl<P> Participant<P> {
    pub fn new(process: P) -> Participant<P> {
        Participant {
            process,
            vote: None,
            decision_ack: false,
        }
    }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub enum CoordinatorState<T>
where
    T: Time,
{
    Abort,
    Commit,
    Voting { vote_timeout_start: T },
    WaitingForDecisionAck { ack_timeout_start: T },
    WaitingForStart,
    WaitingForVote,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct CoordinatorContext<P, T>
where
    P: Process,
    T: Time,
{
    pub(super) participants: Vec<Participant<P>>,
    pub(super) state: CoordinatorState<T>,
}