meerkat-runtime 0.6.0

v9 runtime control-plane for Meerkat agent lifecycle
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
83
84
85
86
87

//! Runtime impl of [`meerkat_core::handles::CommsDrainHandle`].

use std::sync::Arc;

use meerkat_core::handles::{CommsDrainHandle, DrainExitReason, DrainMode, DslTransitionError};

use super::HandleDslAuthority;
use crate::meerkat_machine::dsl as mm_dsl;

/// Runtime-backed [`CommsDrainHandle`] impl.
///
/// Routes every trait method to the corresponding DSL input / signal on a
/// dedicated per-session MeerkatMachine DSL authority.
#[derive(Debug)]
pub struct RuntimeCommsDrainHandle {
    dsl: Arc<HandleDslAuthority>,
}

impl RuntimeCommsDrainHandle {
    /// Construct a handle backed by the session's shared DSL authority.
    pub fn new(dsl: Arc<HandleDslAuthority>) -> Self {
        Self { dsl }
    }

    /// Construct a handle backed by an ephemeral DSL authority.
    ///
    /// See [`RuntimeTurnStateHandle::ephemeral`].
    pub fn ephemeral() -> Self {
        Self::new(Arc::new(HandleDslAuthority::ephemeral()))
    }
}

impl CommsDrainHandle for RuntimeCommsDrainHandle {
    fn ensure_drain_running(&self) -> Result<(), DslTransitionError> {
        self.dsl.apply_signal(
            mm_dsl::MeerkatMachineSignal::EnsureDrainRunning,
            "CommsDrainHandle::ensure_drain_running",
        )
    }

    fn spawn_drain(&self, mode: DrainMode) -> Result<(), DslTransitionError> {
        let mode = match mode {
            DrainMode::Timed => mm_dsl::DrainMode::Timed,
            DrainMode::AttachedSession => mm_dsl::DrainMode::AttachedSession,
            DrainMode::PersistentHost => mm_dsl::DrainMode::PersistentHost,
        };
        // intra-machine: no route; dispatcher not applicable (handle targets the meerkat DSL directly, not a CompositionDispatcher seam)
        self.dsl.apply_input(
            mm_dsl::MeerkatMachineInput::SpawnDrain { mode },
            "CommsDrainHandle::spawn_drain",
        )
    }

    fn stop_drain(&self) -> Result<(), DslTransitionError> {
        // intra-machine: no route; dispatcher not applicable (handle targets the meerkat DSL directly, not a CompositionDispatcher seam)
        self.dsl.apply_input(
            mm_dsl::MeerkatMachineInput::StopDrain,
            "CommsDrainHandle::stop_drain",
        )
    }

    fn drain_exited_clean(&self) -> Result<(), DslTransitionError> {
        // intra-machine: no route; dispatcher not applicable (handle targets the meerkat DSL directly, not a CompositionDispatcher seam)
        self.dsl.apply_input(
            mm_dsl::MeerkatMachineInput::DrainExitedClean,
            "CommsDrainHandle::drain_exited_clean",
        )
    }

    fn drain_exited_respawnable(&self) -> Result<(), DslTransitionError> {
        // intra-machine: no route; dispatcher not applicable (handle targets the meerkat DSL directly, not a CompositionDispatcher seam)
        self.dsl.apply_input(
            mm_dsl::MeerkatMachineInput::DrainExitedRespawnable,
            "CommsDrainHandle::drain_exited_respawnable",
        )
    }

    fn notify_drain_exited(&self, reason: DrainExitReason) -> Result<(), DslTransitionError> {
        // intra-machine: no route; dispatcher not applicable (handle targets the meerkat DSL directly, not a CompositionDispatcher seam)
        self.dsl.apply_input(
            mm_dsl::MeerkatMachineInput::NotifyDrainExited {
                reason: mm_dsl::DrainExitReason::from(reason),
            },
            "CommsDrainHandle::notify_drain_exited",
        )
    }
}