openraft 0.10.0-alpha.18

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

//! The Raft network interface.
//!
//! This module defines traits for implementing network communication between Raft nodes:
//!
//! ## Network Traits
//!
//! - [`RaftNetworkV2`] - Protocol for sending Raft RPCs (AppendEntries, Vote, Snapshot)
//! - [`RaftNetworkFactory`] - Factory for creating network connections to target nodes
//!
//! ## Key Types
//!
//! - [`Backoff`] - Backoff strategy for retrying failed network operations
//! - [`RPCOption`] - Options for configuring RPC behavior
//! - [`RPCTypes`] - Type definitions for RPC requests and responses
//!
//! ## Usage
//!
//! Applications implement [`RaftNetworkFactory`] to create [`RaftNetworkV2`] instances
//! for communicating with each remote Raft node. The factory is passed to
//! [`Raft::new()`](crate::Raft::new) when creating a Raft instance.
//!
//! See the [Getting Started Guide](crate::docs::getting_started) for implementation
//! details and examples.

mod append_trait;
mod backoff;
mod backoff_trait;
mod factory;
mod raft_network_api;
mod raft_network_v1;
mod rpc_option;
mod rpc_type;
mod snapshot_trait;
mod stream_append_trait;
mod transfer_leader_trait;
mod vote_trait;

pub mod v2;

pub use append_trait::NetAppend;
pub use backoff::Backoff;
pub use backoff_trait::NetBackoff;
pub use factory::RaftNetworkFactory;
pub(crate) use raft_network_api::RaftNetworkApi;
#[allow(deprecated)]
pub use raft_network_v1::RaftNetwork;
pub use rpc_option::RPCOption;
pub use rpc_type::RPCTypes;
pub use snapshot_trait::NetSnapshot;
pub use stream_append_trait::NetStreamAppend;
pub use stream_append_trait::stream_append_sequential;
pub use transfer_leader_trait::NetTransferLeader;
pub use v2::RaftNetworkV2;
pub use vote_trait::NetVote;