Struct Mailbox

pub struct Mailbox { /* private fields */ }

A mailbox to send messages to a running raft node.

Implementations

impl Mailbox

pub fn pears(&self) -> Vec<(u64, Peer)>

Retrieves a list of peers with their IDs. This method returns a vector containing tuples of peer IDs and their respective Peer objects. It iterates over the internal peers map and collects the IDs and cloned Peer instances.

pub async fn send_proposal(&self, message: Vec<u8>) -> Result<Vec<u8>>

Sends a proposal to the leader node. This method first attempts to send the proposal to the local node if it is the leader. If the node is not the leader, it retrieves the leader’s address and sends the proposal to the leader node. If the proposal is successfully handled, the method returns a RaftResponse::Response with the resulting data.

pub async fn send(&self, message: Vec<u8>) -> Result<Vec<u8>>

👎Deprecated

Deprecated method to send a message, internally calls send_proposal.

pub async fn query(&self, query: Vec<u8>) -> Result<Vec<u8>>

Sends a query to the Raft node and returns the response data. It sends a Message::Query containing the query bytes and waits for a response. On success, it returns the data wrapped in RaftResponse::Response.

pub async fn leave(&self) -> Result<()>

Sends a request to leave the Raft cluster. It initiates a ConfigChange to remove the node from the cluster and waits for a response.

pub async fn status(&self) -> Result<Status>

Retrieves the current status of the Raft node. Sends a Message::Status request and waits for a RaftResponse::Status reply, which contains the node’s status.

Trait Implementations

impl Clone for Mailbox

fn clone(&self) -> Mailbox

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.