Struct openraft::raft::RuntimeConfigHandle

pub struct RuntimeConfigHandle<'r, C>
where
    C: RaftTypeConfig,
{ /* private fields */ }

RuntimeConfigHandle is an interface to update runtime config.

These config are mainly designed for testing purpose and special use cases. Usually you don’t need to change runtime config.

Implementations

impl<'r, C> RuntimeConfigHandle<'r, C>

where C: RaftTypeConfig,

pub fn tick(&self, enabled: bool)

Enable or disable raft internal ticker.

Disabling tick will disable election and heartbeat.

pub fn heartbeat(&self, enabled: bool)

Enable or disable heartbeat message when a leader has no more log to replicate.

Note that the follower’s leader-lease will not be renewed if it does receive message from the leader, and it will start election(if Self::elect() is enabled) when the lease timed out.

pub fn elect(&self, enabled: bool)

Enable or disable election for a follower when its leader lease timed out.