concorde 0.7.0

reconfigurable lattice agreement
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

// Copyright 2020 Graydon Hoare <graydon@pobox.com>
// Licensed under the MIT and Apache-2.0 licenses.

use im::OrdSet as ArcOrdSet;
/// `Cfg` is one of the two base lattices we work with (the other is the
/// user-provided so-called `Obj` object-value lattice, not defined in this
/// crate).
///
/// Cfg represents the state of the group of peers _doing_ the lattice
/// agreement. Abstractly it's a 2P-SET that stores the set of peers who have
/// been added and the set who have been removed; the set of "current members"
/// is just the adds minus the removes.
///
/// This lattice is parameterized by a user-provided notion of a Peer. This is
/// anything Ord+Clone but probably ought to be something small, like an integer
/// or UUID or string. Something that identifies a peer, and something you don't
/// mind transmitting sets of, serialized, in messages.
use pergola::{ArcOrdSetWithUnion, DefTraits, LatticeElt, Tuple2};

pub type PeerSetLD<Peer> = ArcOrdSetWithUnion<Peer>;
pub type PeerSetLE<Peer> = LatticeElt<PeerSetLD<Peer>>;
pub type CfgLD<Peer> = Tuple2<PeerSetLD<Peer>, PeerSetLD<Peer>>;
pub type CfgLE<Peer> = LatticeElt<CfgLD<Peer>>;

// Helper methods on the Cfg lattice elements.
pub trait CfgLEExt<Peer: DefTraits> {
    fn added_peers_elt(&self) -> &PeerSetLE<Peer>;
    fn added_peers_elt_mut(&mut self) -> &mut PeerSetLE<Peer>;
    fn added_peers(&self) -> &ArcOrdSet<Peer>;
    fn added_peers_mut(&mut self) -> &mut ArcOrdSet<Peer>;

    fn removed_peers_elt(&self) -> &PeerSetLE<Peer>;
    fn removed_peers_elt_mut(&mut self) -> &mut PeerSetLE<Peer>;
    fn removed_peers(&self) -> &ArcOrdSet<Peer>;
    fn removed_peers_mut(&mut self) -> &mut ArcOrdSet<Peer>;

    fn members(&self) -> ArcOrdSet<Peer>;
}

impl<Peer: DefTraits> CfgLEExt<Peer> for CfgLE<Peer> {
    fn added_peers_elt(&self) -> &PeerSetLE<Peer> {
        &self.value.0
    }
    fn added_peers_elt_mut(&mut self) -> &mut PeerSetLE<Peer> {
        &mut self.value.0
    }
    fn added_peers(&self) -> &ArcOrdSet<Peer> {
        &self.added_peers_elt().value
    }
    fn added_peers_mut(&mut self) -> &mut ArcOrdSet<Peer> {
        &mut self.added_peers_elt_mut().value
    }

    fn removed_peers_elt(&self) -> &PeerSetLE<Peer> {
        &self.value.1
    }
    fn removed_peers_elt_mut(&mut self) -> &mut PeerSetLE<Peer> {
        &mut self.value.1
    }
    fn removed_peers(&self) -> &ArcOrdSet<Peer> {
        &self.removed_peers_elt().value
    }
    fn removed_peers_mut(&mut self) -> &mut ArcOrdSet<Peer> {
        &mut self.removed_peers_elt_mut().value
    }

    fn members(&self) -> ArcOrdSet<Peer> {
        self.added_peers()
            .clone()
            .difference(self.removed_peers().clone())
    }
}