openraft 0.10.0-alpha.26

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

use std::sync::Arc;

use crate::RaftTypeConfig;
use crate::errors::ReplicationClosed;
use crate::replication::inflight_append_queue::InflightAppendQueue;
use crate::replication::stream_state::StreamState;
use crate::storage::RaftLogStorage;
use crate::type_config::alias::MutexOf;

/// Context passed through the AppendEntries request stream.
///
/// This struct is used with `futures_util::stream::unfold` to generate
/// AppendEntries requests. It holds both the mutable state for reading
/// log entries and a queue for tracking in-flight requests.
pub(crate) struct StreamContext<C, LS>
where
    C: RaftTypeConfig,
    LS: RaftLogStorage<C>,
{
    /// Shared state for generating the next request.
    pub(crate) stream_state: Arc<MutexOf<C, StreamState<C, LS>>>,

    /// Tracks in-flight requests for RTT measurement.
    pub(crate) inflight_append_queue: InflightAppendQueue<C>,

    /// Fatal error found while generating the request stream.
    pub(crate) fatal_error: Arc<MutexOf<C, Option<ReplicationClosed>>>,
}