maiko 0.3.1

Lightweight event-driven actor runtime with topic-based pub/sub for Tokio
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use std::time::Duration;

use tokio::sync::{mpsc::Sender, oneshot};

use crate::{
    Event, Topic,
    monitoring::{MonitorCommand, MonitorId},
};

/// Handle for controlling a registered monitor.
///
/// Returned by [`MonitorRegistry::add`](crate::monitoring::MonitorRegistry::add).
///
/// # Example
///
/// ```ignore
/// let handle = supervisor.monitors().add(MyMonitor).await;
///
/// // Pause this specific monitor
/// handle.pause().await;
///
/// // Resume it
/// handle.resume().await;
///
/// // Remove it entirely
/// handle.remove().await;
/// ```
#[derive(Debug, Clone)]
pub struct MonitorHandle<E: Event, T: Topic<E>> {
    id: MonitorId,
    sender: Sender<MonitorCommand<E, T>>,
}

impl<E: Event, T: Topic<E>> MonitorHandle<E, T> {
    pub(crate) fn new(id: MonitorId, sender: Sender<MonitorCommand<E, T>>) -> Self {
        Self { id, sender }
    }

    /// Returns this monitor's unique identifier.
    pub fn id(&self) -> MonitorId {
        self.id
    }

    /// Remove this monitor from the registry.
    ///
    /// Consumes the handle since the monitor can no longer be controlled.
    pub async fn remove(self) {
        let _ = self
            .sender
            .send(MonitorCommand::RemoveMonitor(self.id))
            .await;
    }

    /// Pause this monitor.
    ///
    /// Paused monitors do not receive callbacks. Events continue to flow
    /// through the system normally.
    pub async fn pause(&self) {
        let _ = self.sender.send(MonitorCommand::PauseOne(self.id)).await;
    }

    /// Resume this monitor.
    pub async fn resume(&self) {
        let _ = self.sender.send(MonitorCommand::ResumeOne(self.id)).await;
    }

    /// Flush waits for the monitoring dispatcher queue to be empty and stay
    /// empty for the specified settle window before returning.
    ///
    /// This ensures all events queued before the flush call have been processed.
    pub async fn flush(&self, settle_window: Duration) {
        let (tx, rx) = oneshot::channel();
        let _ = self
            .sender
            .send(MonitorCommand::Flush {
                response: tx,
                settle_window,
            })
            .await;
        let _ = rx.await;
    }
}