Skip to main content

ReplicationGroup

Struct ReplicationGroup 

Source
pub struct ReplicationGroup { /* private fields */ }
Expand description

A simulated Raft cluster of TsdbRaftNodes.

All message delivery, election timeout tracking, and commit-index advancement are driven by calls to ReplicationGroup::tick.

Implementations§

Source§

impl ReplicationGroup

Source

pub fn new(ids: &[&str], timeout_override: Option<&[u32]>) -> Self

Create a group with the given node IDs and (optionally distinct) election timeouts.

Pass timeout_override = None to assign uniform timeouts (10 ticks). Pass a slice of per-node timeouts to make elections deterministic.

Source

pub fn cluster_size(&self) -> usize

Return the number of nodes in the group.

Source

pub fn node(&self, id: &str) -> Option<&TsdbRaftNode>

Return a reference to a node by ID.

Source

pub fn node_mut(&mut self, id: &str) -> Option<&mut TsdbRaftNode>

Return a mutable reference to a node by ID.

Source

pub fn leader_id(&self) -> Option<String>

Find the current leader, if any.

Returns None if no node is in the Leader role.

Source

pub fn leader_count(&self) -> usize

Return the number of nodes currently acting as leader.

In a healthy cluster this should always be <= 1.

Source

pub fn quorum_size(&self) -> usize

Return the quorum size (majority) for this cluster.

Source

pub fn partition(&mut self, id: &str)

Partition a node (simulates network isolation).

Source

pub fn heal(&mut self, id: &str)

Heal a partitioned node.

Source

pub fn propose(&mut self, cmd: TsdbCommand) -> TsdbResult<(String, u64)>

Propose a write command on the current leader.

Returns (leader_id, log_index) or an error if there is no leader.

Source

pub fn propose_write_entry( &mut self, entry: &WriteEntry, ) -> TsdbResult<(String, u64)>

Propose a WriteEntry via the current leader (convenience wrapper).

Returns (leader_id, log_index) or an error.

Source

pub fn propose_and_commit( &mut self, entry: &WriteEntry, max_ticks: u32, ) -> TsdbResult<(String, u64)>

Propose a WriteEntry and wait for quorum commit by ticking.

Returns (leader_id, log_index) after up to max_ticks ticks. Returns an error if the entry is not committed within max_ticks.

Source

pub fn tick(&mut self)

Advance the simulation by one logical tick.

Each tick:

  1. Sends leader heartbeats first (so they enter the bus).
  2. Delivers all pending messages from the bus.
  3. Increments election timers on followers/candidates.
  4. Advances commit indices on the leader.

The order matters: heartbeats are sent first so they can be delivered in the same tick, preventing unnecessary election timeouts.

Source

pub fn tick_n(&mut self, n: u32)

Run n ticks in sequence.

Source

pub fn node_ids(&self) -> Vec<String>

Return all node IDs in the cluster.

Source

pub fn pending_messages(&self) -> usize

Return the number of pending messages on the bus.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> ErasedDestructor for T
where T: 'static,