d-engine-core 0.2.3

Pure Raft consensus algorithm - for building custom Raft-based systems
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

use std::fmt::Debug;
use std::sync::Arc;

use crate::RaftNodeConfig;
use crate::TypeConfig;
use crate::alias::EOF;
use crate::alias::MOF;
use crate::alias::PE;
use crate::alias::REPOF;
use crate::alias::ROF;
use crate::alias::SMHOF;
use crate::alias::SMOF;
use crate::alias::TROF;

pub struct RaftStorageHandles<T: TypeConfig> {
    pub raft_log: Arc<ROF<T>>,
    pub state_machine: Arc<SMOF<T>>,
}

pub struct RaftCoreHandlers<T: TypeConfig> {
    pub election_handler: EOF<T>,
    pub replication_handler: REPOF<T>,
    pub state_machine_handler: Arc<SMHOF<T>>,

    // Raft Log Purge Executor
    pub purge_executor: Arc<PE<T>>,
}

pub struct RaftContext<T>
where
    T: TypeConfig,
{
    pub node_id: u32,

    // Storages
    pub storage: RaftStorageHandles<T>,

    // Network
    pub transport: Arc<TROF<T>>,

    // Cluster Membership
    pub membership: Arc<MOF<T>>,

    // Handlers
    pub handlers: RaftCoreHandlers<T>,

    // RaftNodeConfig
    pub node_config: Arc<RaftNodeConfig>,
}

impl<T> RaftContext<T>
where
    T: TypeConfig,
{
    pub fn raft_log(&self) -> &Arc<ROF<T>> {
        &self.storage.raft_log
    }

    pub fn state_machine(&self) -> &SMOF<T> {
        &self.storage.state_machine
    }

    pub fn transport(&self) -> &Arc<TROF<T>> {
        &self.transport
    }
    pub fn replication_handler(&self) -> &REPOF<T> {
        &self.handlers.replication_handler
    }

    pub fn election_handler(&self) -> &EOF<T> {
        &self.handlers.election_handler
    }

    pub fn state_machine_handler(&self) -> &Arc<SMHOF<T>> {
        &self.handlers.state_machine_handler
    }

    pub fn node_config(&self) -> Arc<RaftNodeConfig> {
        self.node_config.clone()
    }

    pub fn membership(&self) -> Arc<MOF<T>> {
        self.membership.clone()
    }

    pub fn purge_executor(&self) -> Arc<PE<T>> {
        self.handlers.purge_executor.clone()
    }

    pub fn membership_ref(&self) -> &Arc<MOF<T>> {
        &self.membership
    }

    #[cfg(test)]
    pub fn set_membership(
        &mut self,
        membership: Arc<MOF<T>>,
    ) {
        self.membership = membership;
    }

    #[cfg(test)]
    pub fn set_transport(
        &mut self,
        transport: Arc<TROF<T>>,
    ) {
        self.transport = transport
    }
}

impl<T> Debug for RaftContext<T>
where
    T: TypeConfig,
{
    fn fmt(
        &self,
        f: &mut std::fmt::Formatter<'_>,
    ) -> std::fmt::Result {
        f.debug_struct("RaftContext").field("node_id", &self.node_id).finish()
    }
}