RiteRaft - A raft framework, for regular people
This is an attempt to create a layer on top of tikv/raft-rs, that is easier to use and implement. This is not supposed to be the most featureful raft, but instead a convenient interface to get started quickly, and have a working raft in no time.
The interface is strongly inspired by the one used by canonical/raft.
Getting started
In order to "raft" storage, we need to implement the Storage trait for it. Bellow is an example with HashStore, which is a thread-safe wrapper around an HashMap:
/// convienient data structure to pass Message in the raft
#[derive(Serialize, Deserialize)]
pub enum Message {
Insert { key: u64, value: String },
}
#[derive(Clone)]
struct HashStore(Arc<RwLock<HashMap<u64, String>>>);
impl Store for HashStore {
type Error = RaftError;
fn apply(&mut self, message: &[u8]) -> Result<Vec<u8>, Self::Error> {
let message: Message = deserialize(message).unwrap();
let message: Vec<u8> = match message {
Message::Insert { key, value } => {
let mut db = self.0.write().unwrap();
db.insert(key, value.clone());
serialize(&value).unwrap()
}
};
Ok(message)
}
fn snapshot(&self) -> Vec<u8> {
serialize(&self.0.read().unwrap().clone()).unwrap()
}
fn restore(&mut self, snapshot: &[u8]) -> Result<(), Self::Error> {
let new: HashMap<u64, String> = deserialize(snapshot).unwrap();
let mut db = self.0.write().unwrap();
let _ = std::mem::replace(&mut *db, new);
Ok(())
}
}
Only 3 methods need to be implemented for the Store:
Store::apply: applies a commited entry to the store.Store::snapshot: returns snapshot data for the store.Store::restore: applies the snapshot passed as argument.
running the raft
#[tokio::main]
fn main() {
let store = HashStore::new();
let raft = Raft::new(options.raft_addr, store.clone());
let mailbox = Arc::new(raft.mailbox());
let (raft_handle, mailbox) = match options.peer_addr {
Some(addr) => {
info!("running in follower mode");
let handle = tokio::spawn(raft.join(addr));
(handle, mailbox)
}
None => {
info!("running in leader mode");
let handle = tokio::spawn(raft.lead());
(handle, mailbox)
}
};
tokio::join!(raft);
}
The mailbox gives you a way to interact with the raft, for sending a message, or leaving the cluster for example.
Credit
This work is based on raft-frp, but more adjustments and improvements have been made to the code .
License
This library is licensed under either of:
- MIT license LICENSE-MIT or http://opensource.org/licenses/MIT
- Apache License 2.0 LICENSE-APACHE or https://opensource.org/licenses/Apache-2.0
at your option.
![[Solved] Need to upgrade to tokio-1, the example does not work.](https://avatars.githubusercontent.com/u/36896360?v=4)
2.1k Jan 3, 2023
6.1k Dec 27, 2022
3k Jan 3, 2023
873 Nov 12, 2022
19.5k Jan 8, 2023
610 Jan 4, 2023
83 Dec 19, 2022
622 Oct 27, 2022
840 Jan 1, 2023
969 Dec 22, 2022
94 Oct 26, 2022
51 Jun 7, 2022
24 Oct 15, 2022
18 Nov 23, 2022
27 Jan 1, 2023
118 Jun 28, 2022
1.2k Jan 5, 2023
2 Dec 20, 2022
5 Feb 27, 2024