Skip to content

Commit

Permalink
Doc: update doc of Raft::external_request()
Browse files Browse the repository at this point in the history
  • Loading branch information
SteveLauC authored and drmingdrmer committed Jul 26, 2024
1 parent ec42d9a commit cd19048
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions openraft/src/raft/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -768,9 +768,9 @@ where C: RaftTypeConfig

/// Send a request to the Raft core loop in a fire-and-forget manner.
///
/// The request functor will be called with a mutable reference to both the state machine
/// and the network factory and serialized with other Raft core loop processing (e.g., client
/// requests or general state changes). The current state of the system is passed as well.
/// The request functor will be called with an immutable reference to the [`RaftState`]
/// and serialized with other Raft core loop processing (e.g., client requests
/// or general state changes).
///
/// If a response is required, then the caller can store the sender of a one-shot channel
/// in the closure of the request functor, which can then be used to send the response
Expand Down

0 comments on commit cd19048

Please sign in to comment.