Struct actix_raft::admin::InitWithConfig

pub struct InitWithConfig {
    pub members: Vec<NodeId>,
}

Initialize a pristine Raft node with the given config & start a campaign to become leader.

Fields

members: Vec<NodeId>

All currently known members to initialize the new cluster with.

If the ID of the node this command is being submitted to is not present it will be added. If there are duplicates, they will be filtered out to ensure config is proper.

Methods

impl InitWithConfig

pub fn new(members: Vec<NodeId>) -> Self

Construct a new instance.

Trait Implementations

impl<D: AppData, R: AppDataResponse, E: AppError, N: RaftNetwork<D>, S: RaftStorage<D, R, E>> Handler<InitWithConfig> for Raft<D, R, E, N, S>

type Result = ResponseActFuture<Self, (), InitWithConfigError>

The type of value that this handler will return.

fn handle(
    &mut self,
    msg: InitWithConfig,
    ctx: &mut Self::Context
) -> Self::Result

An admin message handler invoked exclusively for cluster formation.

This command will work for single-node or multi-node cluster formation. This command should be called with all discovered nodes which need to be part of cluster.

This command will be rejected if the node is not at index 0 & in the NonVoter state, as either of those constraints being false indicates that the cluster is already formed and in motion.

This routine will set the given config as the active config, only in memory, and will start an election.

All nodes must issue this command at startup, as they will not be able to vote for other nodes until they appear in their config. This handler will ensure that it is safe to execute this command.

Once a node becomes leader and detects that its index is 0, it will commit a new config entry (instead of the normal blank entry created by new leaders).

If a race condition takes place where two nodes persist an initial config and start an election, whichever node becomes leader will end up committing its entries to the cluster.

impl Message for InitWithConfig

type Result = Result<(), InitWithConfigError>

The type of value that this message will resolved with if it is successful.