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

//! Watch handle for async watch tasks.

use crate::RaftTypeConfig;
use crate::type_config::alias::JoinHandleOf;
use crate::type_config::alias::OneshotSenderOf;

/// Handle to control an async watch task.
///
/// Use [`close()`](`Self::close`) to stop watching and wait for the task to complete.
pub struct WatchChangeHandle<C>
where C: RaftTypeConfig
{
    pub(crate) cancel_tx: Option<OneshotSenderOf<C, ()>>,
    pub(crate) join_handle: Option<JoinHandleOf<C, ()>>,
}

impl<C> WatchChangeHandle<C>
where C: RaftTypeConfig
{
    /// Stop watching and wait for the task to complete.
    pub async fn close(&mut self) {
        // Drop the sender to signal shutdown
        drop(self.cancel_tx.take());

        // Wait for task to finish
        if let Some(handle) = self.join_handle.take() {
            handle.await.ok();
        }
    }
}