openraft 0.9.23

Advanced Raft consensus
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

//! Callbacks for ReplicationCore internal communication.
use core::fmt;

use crate::error::StreamingError;
use crate::raft::SnapshotResponse;
use crate::type_config::alias::InstantOf;
use crate::RaftTypeConfig;
use crate::SnapshotMeta;

/// Callback payload when a snapshot transmission finished, successfully or not.
#[derive(Debug)]
pub(crate) struct SnapshotCallback<C: RaftTypeConfig> {
    // TODO: Remove `start_time`.
    //       Because sending snapshot is a long lasting process,
    //       we should not rely on the start time to extend leader lease.
    /// The time when the snapshot replication started on leader.
    ///
    /// This time is used to extend lease of the leader on leader. like a heartbeat.
    pub(crate) start_time: InstantOf<C>,

    /// Meta data of the snapshot to be replicated.
    pub(crate) snapshot_meta: SnapshotMeta<C::NodeId, C::Node>,

    /// The result of the snapshot replication.
    pub(crate) result: Result<SnapshotResponse<C::NodeId>, StreamingError<C>>,
}

impl<C: RaftTypeConfig> SnapshotCallback<C> {
    pub(in crate::replication) fn new(
        start_time: InstantOf<C>,
        snapshot_meta: SnapshotMeta<C::NodeId, C::Node>,
        result: Result<SnapshotResponse<C::NodeId>, StreamingError<C>>,
    ) -> Self {
        Self {
            start_time,
            snapshot_meta,
            result,
        }
    }
}

impl<C: RaftTypeConfig> fmt::Display for SnapshotCallback<C> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "SnapshotCallback {{ start_time: {:?}, snapshot_meta: {}, result:",
            self.start_time, self.snapshot_meta
        )?;

        match &self.result {
            Ok(resp) => write!(f, " Ok({})", resp)?,
            Err(e) => write!(f, " Err({})", e)?,
        };

        write!(f, " }}",)
    }
}