Struct NodeBuilder

pub struct NodeBuilder<T> { /* private fields */ }

Implementations

impl<T> NodeBuilder<T>

where T: Serialize + DeserializeOwned + 'static,

pub fn election_timeout(self, ms: u32) -> Self

Set the election timeout in milliseconds. This is discouraged, as the timeout should be randomized (so that nodes are less likely to simultaneously initiate elections). See eleciton_timeout_range

NB: If election_timeout_range is also set, this will overwrite it.

Defaults to a random value in the range (150, 300)

pub fn election_timeout_range(self, low_ms: u32, high_ms: u32) -> Self

Set the range for the randomized value of the election timeout.

Defaults to (150, 300).

pub fn heartbeat_timeout(self, ms: u32) -> Self

Set the leader heartbeat interval in milliseconds

Defaults to 50

pub fn id(self, id: u32) -> Self

Set the node’s id.

Defaults to a random number

pub fn channel(self, name: &str) -> Self

Set the name of the BroadcastChannel the node should connect to

Defaults to "raft-nodes"

pub fn on_received<F>(self, callback: F) -> Self

where F: Fn(T) + 'static,

Attach a closure to the node that will be called when the node receives a [Message::Payload] message

pub fn on_role_change<F>(self, callback: F) -> Self

where F: Fn(Role) + 'static,

Attach a closure to the node that will be called when the node’s role is changed.

pub fn build(self) -> Arc<Node<T>>

Finalize the builder and construct a Node

Trait Implementations

impl<T> Default for NodeBuilder<T>

fn default() -> Self

Returns the “default value” for a type.