add a simple single memory node example #44

siddontang · 2018-03-22T04:17:39Z

Add a very simple example to let the user know how to use the Raft library basically.

BusyJay · 2018-03-27T12:27:31Z

examples/single_mem_node/main.rs

+use std::thread;
+use std::collections::HashMap;
+
+use raft::*;


Maybe we need to provide a prelude for those frequently used structs.

Yes, we can add an issue with help-wanted.

BusyJay · 2018-03-27T12:27:48Z

examples/single_mem_node/main.rs

+
+enum Msg {
+    Propose { id: u8, cb: ProposeCallback },
+    #[allow(dead_code)] Raft(Message),


Why dead code?

We don't handle Raft message here, but I also want to show how to drive the Raft with step function.

BusyJay · 2018-03-28T05:57:12Z

examples/single_mem_node/main.rs

+fn main() {
+    // Create a storage for Raft, here we just use a simple memory storage.
+    // You need to build your own persistent storage in your production.
+    // Please check the Storage traint in src/storage.rs to see how to implement one.


s/traint/trait/

BusyJay · 2018-03-28T05:59:28Z

examples/single_mem_node/main.rs

+        // Heartbeat tick is for how long the leader needs to send
+        // a heartbeat to keepalive.
+        heartbeat_tick: 3,
+        // The max size for one message, mostly, 1 MB is enough.


Not consistent with the actual configuration.

BusyJay · 2018-03-28T06:02:13Z

examples/single_mem_node/main.rs

+            Err(RecvTimeoutError::Disconnected) => return,
+        }
+
+        if t.elapsed() >= d {


d should be updated if elapsed is less than d.

here I don't need an accurate check, and the elapsed is based on the created time, so the elapsed time will be increased next time, seem no need to update d.

For example, if a message arrive right before timeout, then next tick is called after d * 2 instead of d.

BusyJay · 2018-03-28T06:06:42Z

@queenypingcap PTAL

siddontang · 2018-03-29T05:49:39Z

PTAL @BusyJay

QueenyJin · 2018-03-29T06:13:43Z

@lilin90 PTAL.

lilin90 · 2018-03-29T06:44:51Z

examples/single_mem_node/main.rs

+    #[allow(dead_code)] Raft(Message),
+}
+
+// A simple example about how to use the raft library in Rust.


raft -> Raft

lilin90 · 2018-03-29T06:48:45Z

examples/single_mem_node/main.rs

+
+// A simple example about how to use the raft library in Rust.
+fn main() {
+    // Create a storage for Raft, here we just use a simple memory storage.


-> Create a storage for Raft, and here we just use a simple memory storage.
OR
-> Create a storage for Raft. Here we just use a simple memory storage.

lilin90 · 2018-03-29T06:50:59Z

examples/single_mem_node/main.rs

+        id: 1,
+        // The Raft node list.
+        // Mostly, the peers need to be saved in the storage
+        // and we can get them from Storage::initial_state function, so here


from -> from the

lilin90 · 2018-03-29T06:51:23Z

examples/single_mem_node/main.rs

+        // The Raft node list.
+        // Mostly, the peers need to be saved in the storage
+        // and we can get them from Storage::initial_state function, so here
+        // you need to set empty.


set empty -> set it empty

lilin90 · 2018-03-29T06:58:12Z

examples/single_mem_node/main.rs

+        // it doesn't receive any message from the leader.
+        election_tick: 10,
+        // Heartbeat tick is for how long the leader needs to send
+        // a heartbeat to keepalive.


keepalive -> keep alive

lilin90 · 2018-03-29T07:04:14Z

examples/single_mem_node/main.rs

+        heartbeat_tick: 3,
+        // The max size limits the max size of each append message, mostly, 1 MB is enough.
+        max_size_per_msg: 1024 * 1024 * 1024,
+        // Max inflight msgs that the leader sends message to follower without


message -> messages

lilin90 · 2018-03-29T07:07:48Z

examples/single_mem_node/main.rs

+    let mut t = Instant::now();
+    let mut timeout = Duration::from_millis(100);
+
+    // Use a HashMap to holde the propose callbacks.


holde -> hold
propose -> proposed? (because "propose" is a verb)

lilin90 · 2018-03-29T07:09:48Z

examples/single_mem_node/main.rs

+    }
+
+    if let Some(ref hs) = ready.hs {
+        // Raft HardState changed, we need to persist it.


-> Raft HardState changed. we need to persist it.
OR
-> Raft HardState changed, and we need to persist it.

lilin90 · 2018-03-29T07:10:46Z

examples/single_mem_node/main.rs

+        // the leader after appending Raft entries.
+        let msgs = ready.messages.drain(..);
+        for _msg in msgs {
+            // Send message to other peers.


message -> messages

lilin90 · 2018-03-29T07:26:08Z

examples/single_mem_node/main.rs

+
+        println!("propose a request");
+
+        // Send a command to the Raft, wait the Raft applying it


wait the Raft applying it -> wait for the Raft to apply it

…siddontang/example

siddontang · 2018-03-30T06:21:35Z

PTAL @lilin90 @BusyJay

lilin90

LGTM except line 59. Please update.

lilin90 · 2018-03-30T12:36:30Z

examples/single_mem_node/main.rs

+        // Heartbeat tick is for how long the leader needs to send
+        // a heartbeat to keep alive.
+        heartbeat_tick: 3,
+        // The max size limits the max size of each append message, mostly, 1 MB is enough.


(grammar)
-> The max size limits the max size of each appended message. Mostly, 1 MB is enough.

lilin90 · 2018-04-02T02:14:35Z

LGTM

siddontang · 2018-04-02T04:34:35Z

PTAL @BusyJay

BusyJay

rest LGTM

BusyJay · 2018-04-02T07:12:50Z

examples/single_mem_node/main.rs

+        cb: ProposeCallback,
+    },
+    #[allow(dead_code)]
+    // Here we don't use Raft Message, so use dead_code to


Please put the comment above attributes.

siddontang added 4 commits March 22, 2018 12:14

add a simple single memory node example

2d85ab5

fix stable build

70ce7b8

support raft step

c1675cb

adjust match

e879d34

BusyJay reviewed Mar 27, 2018

View reviewed changes

siddontang added 2 commits March 28, 2018 13:49

Merge branch 'master' into siddontang/example

4eaad68

use prelude

d3afa7b

BusyJay reviewed Mar 28, 2018

View reviewed changes

example: Address commit

226c187

lilin90 reviewed Mar 29, 2018

View reviewed changes

siddontang added 2 commits March 30, 2018 14:18

Address comment

4fbf8de

Merge branch 'siddontang/example' of github.com:pingcap/raft-rs into …

f6fa113

…siddontang/example

lilin90 reviewed Mar 30, 2018

View reviewed changes

Address comment

dc55403

BusyJay reviewed Apr 2, 2018

View reviewed changes

Address comment

efefeb9

BusyJay approved these changes Apr 2, 2018

View reviewed changes

siddontang merged commit 447076a into master Apr 2, 2018

siddontang deleted the siddontang/example branch April 2, 2018 13:53

Hoverbear added this to the 0.2.0 milestone Jul 5, 2018

tisonkun mentioned this pull request Jun 14, 2023

raft: Introduce CommittedEntries pagination #105

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add a simple single memory node example #44

add a simple single memory node example #44

siddontang commented Mar 22, 2018

BusyJay Mar 27, 2018

siddontang Mar 28, 2018

BusyJay Mar 27, 2018

siddontang Mar 28, 2018

BusyJay Mar 28, 2018

BusyJay Mar 28, 2018

BusyJay Mar 28, 2018

siddontang Mar 28, 2018

BusyJay Mar 28, 2018

BusyJay commented Mar 28, 2018

siddontang commented Mar 29, 2018

QueenyJin commented Mar 29, 2018

lilin90 Mar 29, 2018

lilin90 Mar 29, 2018

lilin90 Mar 29, 2018

lilin90 Mar 29, 2018

lilin90 Mar 29, 2018

lilin90 Mar 29, 2018

lilin90 Mar 29, 2018

lilin90 Mar 29, 2018

lilin90 Mar 29, 2018

lilin90 Mar 29, 2018

siddontang commented Mar 30, 2018

lilin90 left a comment

lilin90 Mar 30, 2018

lilin90 commented Apr 2, 2018

siddontang commented Apr 2, 2018

BusyJay left a comment •

edited

Loading

BusyJay Apr 2, 2018


		println!("propose a request");

		// Send a command to the Raft, wait the Raft applying it

add a simple single memory node example #44

add a simple single memory node example #44

Conversation

siddontang commented Mar 22, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BusyJay commented Mar 28, 2018

siddontang commented Mar 29, 2018

QueenyJin commented Mar 29, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

siddontang commented Mar 30, 2018

lilin90 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lilin90 commented Apr 2, 2018

siddontang commented Apr 2, 2018

BusyJay left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BusyJay left a comment •

edited

Loading